Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (26 loc) · 931 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 931 Bytes

Contributing to GitNapse

Thanks for your interest in contributing.

Workflow

  1. Create a branch from main.
  2. Implement your change.
  3. Run local validation.
  4. Open a Pull Request targeting main.

main is protected. Direct pushes are not allowed.

Local Validation

Run at minimum:

cargo check

If your changes affect behavior, update documentation in README.md and docs/.

Pull Request Guidelines

  • Keep PRs focused and scoped.
  • Describe motivation, implementation details, and test evidence.
  • Link related issues if available.
  • Resolve review comments before merge.

Commit Guidance

Use clear commit messages, for example:

  • feat: add authenticated @me repository listing
  • fix: handle oauth runtime initialization
  • docs: add release collaboration section

Security

Do not open public issues for sensitive vulnerabilities. Use the process in SECURITY.md.