Skip to content

docs: standardize commit rules and pull request flows in CONTRIBUTING.md #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KGFCH2 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −2
Open

docs: standardize commit rules and pull request flows in CONTRIBUTING.md #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,15 @@ We welcome:
1. **Check existing issues** — Avoid duplicate work
2. **Create an issue** — Describe your proposal
3. **Wait for approval** — Get feedback before coding
4. **Create a feature branch** — `git checkout -b feature/your-feature`
4. **Create a dedicated branch** — Use clear, lowercase, hyphen-separated names prefixed by category:
- `feat/feature-name` (new features)
- `fix/bug-name` (bug fixes)
- `docs/doc-update` (documentation changes)
- `style/style-change` (CSS or layout updates)
- `refactor/refactoring-task` (code structure refactoring)
- `test/test-scenario` (adding or expanding tests)
5. **Make your changes** — Follow coding standards
6. **Commit** — Write clear commit messages
6. **Commit** — Write clear commit messages matching Conventional Commits rules
7. **Push** — Push to your fork
8. **Create PR** — Submit pull request with description
9. **Respond to reviews** — Address feedback
Expand Down