Skip to content

Commit b318772

Browse files
committed
docs(contributing): Add contributing guide
why: Project had no contributing guidelines for new contributors. what: - Add .github/contributing.md with ruff, mypy, pytest, uv workflow - Reference AGENTS.md and developing docs
1 parent 1195dca commit b318772

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.github/contributing.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the maintainers of this repository before making a change.
5+
6+
See [developing](../docs/developing.md) for environment setup and [AGENTS.md](../AGENTS.md) for
7+
detailed coding standards.
8+
9+
## Pull Request Process
10+
11+
1. **Format and lint**: `uv run ruff format .` then `uv run ruff check . --fix --show-fixes`
12+
2. **Type check**: `uv run mypy`
13+
3. **Test**: `uv run pytest` — all tests must pass before submitting
14+
4. **Document**: Update docs if your change affects the public interface
15+
5. You may merge the Pull Request once you have the sign-off of one other developer. If you
16+
do not have permission to do that, you may request a reviewer to merge it for you.
17+
18+
## Decorum
19+
20+
- Participants will be tolerant of opposing views.
21+
- Participants must ensure that their language and actions are free of personal
22+
attacks and disparaging personal remarks.
23+
- When interpreting the words and actions of others, participants should always
24+
assume good intentions.
25+
- Behaviour which can be reasonably considered harassment will not be tolerated.
26+
27+
Based on [Ruby's Community Conduct Guideline](https://www.ruby-lang.org/en/conduct/)

0 commit comments

Comments
 (0)