feat(readme): Add config section to readme#234
Merged
hubertdeng123 merged 13 commits intomainfrom Feb 19, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #234 +/- ##
=======================================
Coverage 92.81% 92.81%
=======================================
Files 23 23
Lines 1629 1629
=======================================
Hits 1512 1512
Misses 117 117 ☔ View full report in Codecov by Sentry. |
IanWoodard
reviewed
Feb 18, 2025
Contributor
IanWoodard
left a comment
IanWoodard
left a comment
There was a problem hiding this comment.
Some initial feedback, looking good so far
README.md
Outdated
| # - version: The version of the devservices config file. This is used to ensure compatibility between devservices and the config file. | ||
| # - service_name: The name of the service. This is used to identify the service in the config file. | ||
| # - dependencies: A list of dependencies for the service. Each dependency is a yaml block that holds the dependency configuration. There are two types of dependencies: | ||
| # - local: A dependency that is defined in the config file. These dependencies do not have a remote field. |
Contributor
There was a problem hiding this comment.
Should we provide more information about why you may want to use this versus a remote dependency?
Member
Author
There was a problem hiding this comment.
Done, added a sentence
IanWoodard
approved these changes
Feb 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a lot more description for folks on how to setup a devservices config