Add a CONTRIBUTING.md #58
Merged
Conversation
This file contains 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
Missed this one earlier because I was running Docker, but caught it when writing the project setup instructions for CONTRIBUTING.md
This is notably lacking code of conduct information, but happy to add that in if the Reich Lab has one. Other than that, this is hopefully a good foundation to iterate on.
bsweger
commented
Nov 13, 2024
requirements/requirements-doc.txt
Outdated
There was a problem hiding this comment.
A new requirements file that is specific to documentation. Most people won't need this unless they want to build and serve the docs locally.
elray1
reviewed
Nov 14, 2024
Comment on lines
+117
to
+118
| uv pip compile pyproject.toml -o requirements/requirements.txt && uv pip compile pyproject.toml --extra dev -o requirements/requirements-dev.txt | ||
| ``` |
There was a problem hiding this comment.
should this include stuff for how to build requirements/requirements-doc.txt?
There was a problem hiding this comment.
Good question--I was operating under the assumption that the docs requirements will be pretty stable and contributors won't have to worry about them (I know, I know)
There was a problem hiding this comment.
@elray1 I added that info to the documentation section
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #40
Add a CONTRIBUTING.md file to Cladetime
This is notably lacking code of conduct information, but happy to
add that in if the Reich Lab has one. Other than that, this
is hopefully a good foundation to iterate on.