Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding coding examples for Contact and ContactOption #24

Closed

Conversation

akanshyabhat
Copy link
Contributor

@akanshyabhat akanshyabhat commented Feb 29, 2024

Adding coding examples for Contact and ContactOption

♻️ Current situation & Problem

When I was creating a contact for our application, I was unable to see coding examples. These added examples hope to clarify how someone might build and implement these features.

📚 Documentation

  • Improve documentation by showing an example of hot to build new Contact as well as custom ContactOptions

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@Supereg Supereg requested a review from PSchmiedmayer March 1, 2024 01:35
Copy link

codecov bot commented Mar 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.69%. Comparing base (494b776) to head (87894f8).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #24   +/-   ##
=======================================
  Coverage   78.69%   78.69%           
=======================================
  Files           4        4           
  Lines         319      319           
=======================================
  Hits          251      251           
  Misses         68       68           
Files Coverage Δ
Sources/SpeziContact/Models/Contact.swift 100.00% <ø> (ø)
Sources/SpeziContact/Models/ContactOption.swift 86.96% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 494b776...87894f8. Read the comment docs.

@PSchmiedmayer PSchmiedmayer requested review from philippzagar and removed request for PSchmiedmayer March 1, 2024 03:48
@philippzagar philippzagar added the enhancement New feature or request label Mar 5, 2024
Copy link
Member

@philippzagar philippzagar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @akanshyabhat! 🚀

I had some comments about slightly increasing the example to showcase the usage within a larger context. Feel free to address them and request a new review 🚀

Sources/SpeziContact/Models/Contact.swift Outdated Show resolved Hide resolved
Sources/SpeziContact/Models/Contact.swift Outdated Show resolved Hide resolved
Sources/SpeziContact/Models/ContactOption.swift Outdated Show resolved Hide resolved
Sources/SpeziContact/Models/ContactOption.swift Outdated Show resolved Hide resolved
@akanshyabhat
Copy link
Contributor Author

Thanks for the PR @akanshyabhat! 🚀

I had some comments about slightly increasing the example to showcase the usage within a larger context. Feel free to address them and request a new review 🚀

Thank you so much for the feedback @philippzagar! I've updated it accordingly please take a look whenever you can!

Copy link
Member

@philippzagar philippzagar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments left @akanshyabhat, thanks for incorporating the feedback!

Sources/SpeziContact/Models/ContactOption.swift Outdated Show resolved Hide resolved
Sources/SpeziContact/Models/ContactOption.swift Outdated Show resolved Hide resolved
Sources/SpeziContact/Models/Contact.swift Show resolved Hide resolved
@akanshyabhat
Copy link
Contributor Author

@philippzagar Just addressed these changes! Thank you so much for your patience and time. I really appreciate it!

@philippzagar
Copy link
Member

@akanshyabhat There are some unresolved discussion items, please resolve them first and then request a review

@akanshyabhat
Copy link
Contributor Author

akanshyabhat commented Mar 5, 2024

@akanshyabhat There are some unresolved discussion items, please resolve them first and then request a review

So sorry @philippzagar - I forgot to hit the resolve button! They have been resolved now :) I'm not able to re-request a review from my end, so if you could take a look, that would be great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants