diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa724cddc..add4825fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,17 @@ Please try to include as much information as you can. Details like these are inc * Anything unusual about your environment or deployment +## Finding contributions to work on +Looking at the existing issues is a great way to find something to contribute to. We label issues that are well-defined and ready for community contributions with the "ready for contribution" label. + +Check our [Ready for Contribution](../../issues?q=is%3Aissue%20state%3Aopen%20label%3A%22ready%20for%20contribution%22) issues for items you can work on. + +Before starting work on any issue: +1. Check if someone is already assigned or working on it +2. Comment on the issue to express your interest and ask any clarifying questions +3. Wait for maintainer confirmation before beginning significant work + + ## Development Environment This project uses [hatchling](https://hatch.pypa.io/latest/build/#hatchling) as the build backend and [hatch](https://hatch.pypa.io/latest/) for development workflow management. @@ -70,7 +81,7 @@ This project uses [hatchling](https://hatch.pypa.io/latest/build/#hatchling) as ### Pre-commit Hooks -We use [pre-commit](https://pre-commit.com/) to automatically run quality checks before each commit. The hook will run `hatch run format`, `hatch run lint`, `hatch run test`, and `hatch run cz check` on when you make a commit, ensuring code consistency. +We use [pre-commit](https://pre-commit.com/) to automatically run quality checks before each commit. The hook will run `hatch run format`, `hatch run lint`, `hatch run test`, and `hatch run cz check` when you make a commit, ensuring code consistency. The pre-commit hook is installed with: @@ -122,14 +133,6 @@ To send us a pull request, please: 8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. -## Finding contributions to work on -Looking at the existing issues is a great way to find something to contribute to. - -You can check: -- Our known bugs list in [Bug Reports](../../issues?q=is%3Aissue%20state%3Aopen%20label%3Abug) for issues that need fixing -- Feature requests in [Feature Requests](../../issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement) for new functionality to implement - - ## Code of Conduct This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact