Create CONTRIBUTING.md #4
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
There was a problem hiding this comment.
Pull Request Overview
Adds a new CONTRIBUTING.md file to outline how external contributors can fork, branch, install dependencies, run tests, format code, and submit pull requests.
- Introduces step-by-step contribution workflow
- Specifies use of Poetry for setup and Black for formatting
- Encourages following existing code style and adding tests
Comments suppressed due to low confidence (2)
CONTRIBUTING.md:1
- [nitpick] Consider adding a link or reference to the project’s Code of Conduct to guide contributors on expected community behavior.
## Contributing
CONTRIBUTING.md:3
- [nitpick] You might include a step to open an issue or check existing issues before starting work, which helps avoid duplicate efforts.
Contributions are welcome! To contribute to this project:
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.
No description provided.