docs: Add CONTRIBUTING.md#9
Conversation
|
@Agent-Hellboy Could you please review this? |
|
|
||
| 1. **Fork the repo** and create your branch from `main`. | ||
| 2. If you've added code that should be tested, **add tests**. | ||
| 3. If you've changed APIs, **update the documentation**. |
There was a problem hiding this comment.
Update the documentation inside README
| 2. If you've added code that should be tested, **add tests**. | ||
| 3. If you've changed APIs, **update the documentation**. | ||
| 4. Ensure the **test suite passes**. | ||
| 5. Make sure your code **lints**. |
There was a problem hiding this comment.
There is a pre-commit hook; mention it here that they should install the pre-commit hook.
| Before you submit a pull request, check that it meets these guidelines: | ||
|
|
||
| 1. The pull request should include tests. | ||
| 2. If the pull request adds functionality, the docs should be updated. |
There was a problem hiding this comment.
They need to update the README, and they should install pre-commit hook so that lint and other checks run before they add a PR.
|
Hi @debug-soham, thanks for the PR. Please address these minor comments. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #9 +/- ##
=======================================
Coverage 96.49% 96.49%
=======================================
Files 4 4
Lines 114 114
=======================================
Hits 110 110
Misses 4 4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Updated pull request guidelines to include pre-commit hooks installation and clarified requirements for tests and documentation updates.
|
Done. Could you please review it again and let me know if there's anything to update? |
|
Can you please add |
2 participants
This PR introduces a
CONTRIBUTING.mdfile to provide clear guidelines for new contributors. This will help standardize the process for submitting issues, feature requests, and pull requests, making it easier for the community to get involved.Under Hacktoberfest