- Remove all .github references (removed in 6c644dd but docs still referenced)
- Rewrite review-pr skill to use Gitea API instead of gh CLI
- Add gitea-pr.sh helper for Gitea API calls (view/diff/files/comments)
- Update project structure tree: add scripts/, .woodpecker.yml, ci-cd.md,
status-update-checklist.md, commit-docs-reminder.sh, RESEARCH-SDD-TOOLS.md
- Fix skills count 14 → 15 (add create-skill to DOCS.md)
- Remove .github references from CONTRIBUTING.md, SECURITY.md, init-project
- Add GITEA_TOKEN to .env.example
- Update CI/CD placeholder in RECOMMENDATIONS.md to Woodpecker
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2.4 KiB
2.4 KiB
Contributing
Guidelines for contributing to this project. Adapt this file to your team's workflow.
Commit Messages
This project follows Conventional Commits:
type(scope): description
Types
| Type | When to use |
|---|---|
feat |
New feature or capability |
fix |
Bug fix |
docs |
Documentation only |
refactor |
Code change that neither fixes a bug nor adds a feature |
test |
Adding or updating tests |
chore |
Build, CI, dependencies, tooling |
style |
Formatting, whitespace (no logic change) |
perf |
Performance improvement |
Scopes (optional)
Use the area of the codebase affected: frontend, backend, api, auth, docs, agents, llm, infra.
Examples
feat(backend): add webhook signature verification
fix(frontend): prevent double form submission
docs(agents): update frontend-architect profile for React 19
refactor(api): extract payment logic into separate module
chore: update dependencies
Pull Requests
- Create a feature branch from
main - Keep PRs focused — one concern per PR
- Ensure no secrets or credentials in the diff
- Update relevant documentation if behavior changes
- Request review from the appropriate owner
Branch Naming
type/short-description
Examples: feat/webhook-verification, fix/login-redirect, docs/update-phases.
Adding Documentation
- Create new
.mdfiles underdocs/in the appropriate subdirectory - Write in English
- Include a metadata header:
--- **Phase:** Phase N (Description) **Status:** Draft / Active / Locked **Owner:** Team or person --- - Update
DOCS.mdindex with a link to the new file - Update the project structure tree in
README.mdif adding a new directory
Adding Agent Profiles
- Create a new
.mdfile inagents/ - Follow the structure of existing profiles (role, responsibilities, guidelines, checklist)
- Include context7 verification instructions for version-sensitive recommendations
- No changes to
RULES.mdneeded unless the agent selection protocol changes - Update
DOCS.mdandREADME.mdto reference the new profile
Adding ADRs
- Copy
docs/adr/0000-template.mdtodocs/adr/NNNN-title.md - Fill in context, decision, consequences
- Link the ADR in
RECOMMENDATIONS.mdsection 7 - Follow the guidelines in
docs/adr/README.md