docs: add How to Contribute section to README#215
Merged
Conversation
Contributor
SparkZou
commented
Jan 10, 2026
SparkZou
commented
- Add detailed contribution guide with prerequisites
- Document make install command and its functions
- Document make check command and quality checks
- Include quick tips for contributors
- Reference CONTRIBUTING.md for detailed guidelines
- Add detailed contribution guide with prerequisites - Document make install command and its functions - Document make check command and quality checks - Include quick tips for contributors - Reference CONTRIBUTING.md for detailed guidelines
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive "How to Contribute" section to the README, making it easier for new contributors to get started with the project. The documentation includes setup instructions, prerequisites, and references to the detailed CONTRIBUTING.md file.
Changes:
- Added a new "How to Contribute" section with development environment setup instructions
- Documented the
make installandmake checkcommands with detailed explanations - Included quick contribution tips and references to CONTRIBUTING.md
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The `make check` command runs: | ||
| - **Lock file verification**: Ensures `pyproject.toml` consistency | ||
| - **Pre-commit hooks**: Lints code with Ruff, formats with Black |
There was a problem hiding this comment.
The documentation mentions "formats with Black" but the project actually uses "ruff-format" for code formatting, as seen in the .pre-commit-config.yaml file. This should be corrected to accurately reflect the tools used in the project.
Suggested change
| - **Pre-commit hooks**: Lints code with Ruff, formats with Black | |
| - **Pre-commit hooks**: Lints and formats code with Ruff (`ruff-format`) |
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
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.