Skip to content

Commit 920342b

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 for coding standards
1 parent 46b29fe commit 920342b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/contributing.md

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

0 commit comments

Comments
 (0)