Add developer docs section to readme #126
Merged
Conversation
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
Collaborator
|
can you add what is missing to the https://github.com/HydrologicEngineeringCenter/cwms-python/blob/main/CONTRIBUTING.md file? |
Add reference to CONTRIBUTING Move all dependency links to the top of the CONTRIBUTING
|
Collaborator
Author
|
Completely missed the CONTRIBUTING file, opted to move the dependency links together at the top of CONTRIBUTING |
Enovotny
approved these changes
Feb 11, 2025
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.
When setting up cwms-python for development I was looking up the commands to run poetry.
I thought it would be helpful for others (and myself in the future) to have these documented in a developers section of the primary README file.
I also created a images directory under docs for any images we might want to place in the various README files.