Update CONTRIBUTING.md guidelines #40

New issue

Closed

opened 2026-02-15 03:52:31 +03:00 by NiXTheDev · 0 comments

NiXTheDev commented

2026-02-15 03:52:31 +03:00

(Migrated from github.com)

Description

Overhaul CONTRIBUTING.md with clearer guidelines and better structure for external contributors.

Current Issues

Branch targeting rules are not prominent enough
Missing examples for common contribution scenarios
No clear PR checklist
Lacking guidance on commit message format
No mention of the 'implements #N' convention

Implementation Plan

Prominent branch targeting section
- Move to top of document
- Add warning/callout box
- Explain dev vs release branch purpose
- Add examples of correct vs incorrect targeting
Add PR checklist template
- Tests pass
- Documentation updated
- Follows commit conventions
- Targets correct branch
- Issue referenced
Commit message guidelines
- Conventional commits format
- Issue reference requirement
- Examples of good vs bad messages
- Multi-line commit template
External contributor guidance
- Fork workflow
- Syncing with upstream
- Handling merge conflicts
- Testing before PR
Code style section
- Running bun ltf
- Pre-commit checks
- Auto-formatting with Prettier

Acceptance Criteria

Branch targeting prominently featured
PR checklist included
Commit message examples provided
External contributor workflow documented
Code style requirements clear

Part of Epic #38

## Description Overhaul CONTRIBUTING.md with clearer guidelines and better structure for external contributors. ## Current Issues - Branch targeting rules are not prominent enough - Missing examples for common contribution scenarios - No clear PR checklist - Lacking guidance on commit message format - No mention of the 'implements #N' convention ## Implementation Plan 1. **Prominent branch targeting section** - Move to top of document - Add warning/callout box - Explain dev vs release branch purpose - Add examples of correct vs incorrect targeting 2. **Add PR checklist template** - Tests pass - Documentation updated - Follows commit conventions - Targets correct branch - Issue referenced 3. **Commit message guidelines** - Conventional commits format - Issue reference requirement - Examples of good vs bad messages - Multi-line commit template 4. **External contributor guidance** - Fork workflow - Syncing with upstream - Handling merge conflicts - Testing before PR 5. **Code style section** - Running bun ltf - Pre-commit checks - Auto-formatting with Prettier ## Acceptance Criteria - [ ] Branch targeting prominently featured - [ ] PR checklist included - [ ] Commit message examples provided - [ ] External contributor workflow documented - [ ] Code style requirements clear ## Related Part of Epic #38