Add CONTRIBUTING.md #332
Merged
Add CONTRIBUTING.md #332
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
jsoules
approved these changes
Dec 2, 2025
Collaborator
jsoules
left a comment
jsoules
left a comment
There was a problem hiding this comment.
I think this is great; I made a couple wording tweaks which you can feel free to ignore.
Comment on lines
+42
to
+44
| still builds the example models and that they still run as expected. We | ||
| recommend formatting the Python code with | ||
| [`black`](https://black.readthedocs.io/en/stable/) before submission. |
Collaborator
There was a problem hiding this comment.
Have we blacked all our own codebase? If so, we could make this a requirement rather than a recommendation. (It is also fine to leave it as a recommendation)
Collaborator
Author
There was a problem hiding this comment.
I agree, but I also don't want to make any requirement like that which isn't enforced by CI, which this currently is not
Co-authored-by: Jeff Soules <[email protected]>
Collaborator
|
Looks good to me |
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.
As suggested in the JOSS review issue openjournals/joss-reviews#9531 (comment)