Skip to content

Commit 41ae579

Browse files
committed
docs: add contributing section
1 parent cbadcea commit 41ae579

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,16 @@ _Run the test suite against all supported python versions._
277277
$ tox
278278
```
279279

280+
## Contributing
281+
282+
1. Create an issue with all necessary details.
283+
2. Create a branch off from `main`.
284+
3. Make changes.
285+
4. Verify tests pass in all supported python versions: `tox`.
286+
5. Verify code conventions are maintained: `git add --all && pre-commit run -a`.
287+
6. Create your commit following the [conventionalcommits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
288+
7. Create a pull request with all necessary details: description, testing notes, resolved issues.
289+
280290
## Publishing
281291

282292
**Create**

0 commit comments

Comments
 (0)