forked from newren/git-filter-repo
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Create CONTRIBUTING.md #1
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
Repository needs contribution guidelines to establish workflow expectations for potential contributors.
Proposed Solution
Adapt CONTRIBUTING.md from KemingHe/common-devx repository with modifications for git-crypt-retro context:
- Trunk-based development model (main tracks upstream, development is default)
- Issue-first workflow (all work requires approved issue)
- Conventional commit format:
type(scope): description - Branch naming:
[type]/[description]/[username] - Self-review requirements for AI-assisted contributions
- Reference to design documents in docs/ for context
Key differences from common-devx:
- Document that main branch is upstream mirror (read-only for most contributors)
- Development branch is where contributions land
- Testing strategy references upstream test suite on main branch
E2E Testing (new addition):
- Include symmetric key for KemingHe/git-crypt-retro-e2e-test repository
- Document key is for testing only, intentionally public
- Reference honeytoken pattern:
honeytokens/v<semver>.secret
Alternatives Considered
Writing from scratch, but common-devx template provides proven structure and can be adapted efficiently.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation