diff options
| author | Aiden Cline <[email protected]> | 2026-01-08 11:23:52 -0600 |
|---|---|---|
| committer | Aiden Cline <[email protected]> | 2026-01-08 11:23:52 -0600 |
| commit | 970796b83280ca82b0545c6a2701ade01b733031 (patch) | |
| tree | 90e0dee567dc296e426f9ebe9b16734696a666c8 /CONTRIBUTING.md | |
| parent | 3c5043497c159585654169aab3c7b791d861090f (diff) | |
| download | opencode-970796b83280ca82b0545c6a2701ade01b733031.tar.gz opencode-970796b83280ca82b0545c6a2701ade01b733031.zip | |
docs: add PR title guidelines and workflow to enforce conventional commits
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08ab0159c..f30d795a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,6 +155,24 @@ With that said, you may want to try these methods, as they might work for you. - Avoid having verbose LLM generated PR descriptions - Before adding new functions or functionality, ensure that such behavior doesn't already exist elsewhere in the codebase. +### PR Titles + +PR titles should follow conventional commit standards: + +- `feat:` new feature or functionality +- `fix:` bug fix +- `docs:` documentation or README changes +- `chore:` maintenance tasks, dependency updates, etc. +- `refactor:` code refactoring without changing behavior +- `test:` adding or updating tests + +Examples: + +- `docs: update contributing guidelines` +- `fix: resolve crash on startup` +- `feat: add dark mode support` +- `chore: bump dependency versions` + ### Style Preferences These are not strictly enforced, they are just general guidelines: |