Skip to content

Commit bf24ebf

Browse files
authored
feat: Add additional intructions for contributors to find issues that are ready to be worked on (#595)
1 parent 09ca806 commit bf24ebf

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Please try to include as much information as you can. Details like these are inc
2525
* Anything unusual about your environment or deployment
2626

2727

28+
## Finding contributions to work on
29+
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.
30+
31+
Check our [Ready for Contribution](../../issues?q=is%3Aissue%20state%3Aopen%20label%3A%22ready%20for%20contribution%22) issues for items you can work on.
32+
33+
Before starting work on any issue:
34+
1. Check if someone is already assigned or working on it
35+
2. Comment on the issue to express your interest and ask any clarifying questions
36+
3. Wait for maintainer confirmation before beginning significant work
37+
38+
2839
## Development Environment
2940

3041
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
7081

7182
### Pre-commit Hooks
7283

73-
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.
84+
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.
7485

7586
The pre-commit hook is installed with:
7687

@@ -122,14 +133,6 @@ To send us a pull request, please:
122133
8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
123134

124135

125-
## Finding contributions to work on
126-
Looking at the existing issues is a great way to find something to contribute to.
127-
128-
You can check:
129-
- Our known bugs list in [Bug Reports](../../issues?q=is%3Aissue%20state%3Aopen%20label%3Abug) for issues that need fixing
130-
- Feature requests in [Feature Requests](../../issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement) for new functionality to implement
131-
132-
133136
## Code of Conduct
134137
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
135138
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact

0 commit comments

Comments
 (0)