Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.49 KB

Contributing

Git Workflow

Branches

  • main is the production branch. Never push directly to main.
  • All changes go through feature branches merged via Pull Request.
  • Branch naming conventions:
    • feat/description — new features
    • fix/description — bug fixes
    • chore/description — maintenance, CI, docs

Pull Requests

  1. Create a feature branch from main
  2. Make your changes and push
  3. Open a PR targeting main
  4. CI must pass (green check) before merge
  5. Squash-merge or rebase-merge preferred

Tests

Tests must pass before merging. CI runs automatically on every push and PR.

pip install -e ".[test]"
pytest tests/ -v

Conformance tests against the Proof Specification run as part of the suite. If you modify the chain hash algorithm or proof structure, update the spec and test vectors first.

Code Style

  • Python 3.10+, type hints where helpful
  • No linter enforced yet — match existing style
  • Keep functions short, no deep nesting
  • No comments unless the logic is non-obvious

Security

If you discover a security vulnerability, do not open a public issue. Email contact@arkforge.tech with details.

Releases

Releases follow semver. To create a release:

git tag v0.3.0
git push origin v0.3.0

This triggers the release workflow which:

  1. Runs the full test suite (gate)
  2. Creates a GitHub Release with auto-generated changelog