Skip to content

Add contributing guide for developers - #274

Merged
offbyone merged 3 commits into
hamcrest:mainfrom
brunns:add-contributing-guide
Sep 29, 2026
Merged

offbyone merged 3 commits into
hamcrest:mainfrom
brunns:add-contributing-guide

Conversation

@brunns

@brunns brunns commented Feb 12, 2026

Copy link
Copy Markdown
Member

Summary

Add comprehensive CONTRIBUTING.md to help new contributors understand the development workflow.

Contents

  • Development Setup: Installing dependencies, pre-commit hooks, using tox
  • Running Tests: pytest, tox, coverage, testing across Python versions
  • Code Style and Linting: black, ruff, pre-commit hooks
  • Type Checking: mypy, type hint tests
  • Adding Changelog Entries: towncrier workflow (REQUIRED for code changes)
  • Submitting Pull Requests: PR guidelines, CI workflow, branch naming
  • Release Process: For maintainers - using release.sh and automated publishing

Key Points

  • ⚠️ Changelog entries are required for all code changes (but not for documentation-only changes)
  • 🧪 Contributors should run tox -s before submitting PRs
  • 🤖 CI runs automatically on all pull requests
  • 📦 Releases are automated via git tags

This guide should help reduce friction for new contributors and ensure consistent quality across contributions.

🤖 Generated with Claude Code

Add comprehensive CONTRIBUTING.md covering:
- Development setup and dependencies
- Running tests with pytest and tox
- Code style and linting with pre-commit
- Type checking with mypy
- Adding changelog entries with towncrier
- PR submission guidelines and CI workflow
- Release process for maintainers

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@brunns
brunns had a problem deploying to publish-test-release February 12, 2026 14:19 — with GitHub Actions Failure
@offbyone
offbyone requested a deployment to publish-test-release September 29, 2026 21:09 — with GitHub Actions Waiting
@offbyone
offbyone merged commit e6bfb21 into hamcrest:main Sep 29, 2026
25 of 26 checks passed

This branch is waiting to be deployed

1 waiting deployment
publish-test-release — 75fc84d9 Waiting Sep 29, 2026 by offbyone via Publish in-dev package to test.pypi.org #201
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.

2 participants