Contributing to Gufo Err¶
Thank you for your interest in contributing! Before submitting a patch or issue, please review the following guidelines.
FAQ¶
Please check the FAQ for answers to common questions about contributing, setup, and usage.
Code of Conduct¶
This project follows the Gufo Stack Code of Conduct. Please be respectful and constructive in all interactions.
Reporting Issues and Discussions¶
- Report bugs and feature requests via Issues.
- Discuss ideas and ask questions in Discussions.
- Code contributions go via Pull Requests.
Pull Requests¶
Before opening a PR, make sure you're familiar with the project conventions:
- Project Structure — directory layout and key files
- Code Quality Standards — formatting (ruff), linting, mypy strict, test coverage expectations
- Development Environment — VS Code dev container for a ready-to-go setup
- Building and Testing — how to build, run tests, and check linting locally
- Supported Standards — PEP, RFC, and other relevant standards and regulations
PR Checklist¶
- Code follows code quality standards
- Tests pass (
pytest -vv) and lints are clean (ruff,mypy --strict) - Your changes follow the existing conventions (see codebase overview)
- If applicable, documentation is updated to match your changes
- CHANGELOG.md updated with a brief description of your change
PR Guidelines¶
- One change per PR. Keep diffs focused.
- Link any relevant issues in the PR description.
- Use a clear commit message (imperative mood, e.g., "add validation for X").
- If your PR touches the configuration schema, make sure the config docs reflect the changes.
Where to Start¶
New to the project? Check the developer guide for an overview of the codebase, tooling, and workflows.