Skip to content

chore: add CONTRIBUTING.md - #30

Merged
jkowalleck merged 2 commits into
mainfrom
copilot/add-contributing-file
Jul 17, 2026
Merged

jkowalleck merged 2 commits into
mainfrom
copilot/add-contributing-file

Conversation

Copilot AI commented Jul 17, 2026 •

Copy link
Copy Markdown

The repository lacked contributor guidance. Adds CONTRIBUTING.md covering the full contributor workflow.

What's included

  • Issues – when to open one (bugs, features, and before starting larger changes/refactors)
  • Pull Requests – PRs must be focused on one thing; larger scope requires a prior issue discussion
  • Local setup – clone + pip install -e ".[testing]"
  • Tests – python -m pytest tests
  • Static analysis – python -m mypy -v (references .mypy.ini)
  • Deployment – maintainers cut a GitHub Release; python-publish workflow handles the PyPI upload automatically

Copilot AI linked an issue Jul 17, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add CONTRIBUTING.md to guide contributions chore: add CONTRIBUTING.md Jul 17, 2026
Copilot AI requested a review from jkowalleck July 17, 2026 08:48
@jkowalleck
jkowalleck requested a review from Copilot July 17, 2026 08:55
@jkowalleck
jkowalleck marked this pull request as ready for review July 17, 2026 08:55

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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.

@jkowalleck
jkowalleck merged commit 3f73b0f into main Jul 17, 2026
20 checks passed
@jkowalleck
jkowalleck deleted the copilot/add-contributing-file branch July 17, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: add CONTRIBUTING.md

3 participants