Repository navigation
chore: add CONTRIBUTING.md - #30
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Add CONTRIBUTING.md to guide contributions
chore: add CONTRIBUTING.md
Jul 17, 2026
jkowalleck
approved these changes
Jul 17, 2026
There was a problem hiding this comment.
Pull request overview
Adds contributor guidance to the repository by introducing a CONTRIBUTING.md that documents the expected workflow for issues, pull requests, local setup, testing, static analysis, and release publishing. The instructions align with the existing repo configuration (e.g., requires-python >=3.9, .mypy.ini, tests/, and the python-publish workflow).
Changes:
- Add a new
CONTRIBUTING.mdwith guidance on when/how to open issues and submit focused PRs. - Document local development setup using
pip install -e ".[testing]". - Document how to run tests (
python -m pytest tests), mypy (python -m mypy -v), and how releases are published via GitHub Actions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repository lacked contributor guidance. Adds
CONTRIBUTING.mdcovering the full contributor workflow.What's included
pip install -e ".[testing]"python -m pytest testspython -m mypy -v(references.mypy.ini)python-publishworkflow handles the PyPI upload automatically