Skip to content

Commit 9f0bc60

Browse files
committed
docs(contributing): Update for project tooling
why: Template referenced flake8 and make test; project uses ruff, mypy, and uv. what: - Rewrite PR process for ruff, mypy, pytest, uv workflow - Reference AGENTS.md and developing docs
1 parent a8b5f66 commit 9f0bc60

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

.github/contributing.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
11
# Contributing
22

33
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.
4+
email, or any other method with the maintainers of this repository before making a change.
55

6-
Please note we have a code of conduct, please follow it in all your interactions with the project.
6+
See [developing](../docs/developing.md) for environment setup and [AGENTS.md](../AGENTS.md) for
7+
detailed coding standards.
78

89
## Pull Request Process
910

10-
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11-
build.
12-
2. This project uses flake8 to conform with common Python standards. Make sure
13-
to run your code through linter using latest version of flake8, before pull request.
14-
3. Bad documnentation is a Bug. If your change demands documentation update, please do so. If you
15-
find an issue with documentation, take the time to improve or fix it.
16-
4. pytest is used for automated testing. Please make sure to update tests that are needed, and to run
17-
`make test` before submitting your pull request. This should prevent issues with CI and
18-
make the review and merging process easier and faster.
19-
5. Update the README.md with details of changes to the interface, this includes new environment
20-
variables, exposed ports, useful file locations and container parameters.
21-
6. Increase the version numbers in any examples files and the README.md to the new version that this
22-
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
23-
7. You may merge the Pull Request in once you have the sign-off of one other developer. If you
24-
do not have permission to do that, you may request reviewer to merge it for you.
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.
2517

2618
## Decorum
2719

0 commit comments

Comments
 (0)