Skip to content

Commit 2db7f61

Browse files
committed
docs: add commit message standard to guidelines
1 parent 53bcc04 commit 2db7f61

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/copilot-instructions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,26 @@ RobotCode is a comprehensive Robot Framework toolkit that provides IDE extension
102102

103103
This rule ensures consistency across the codebase, improves discoverability for international contributors, and enables reliable tooling (linters, analyzers, and internationalized docs). Use English even when writing examples or user-facing strings in tests; if localised strings are required, keep the canonical code-level names and primary docs in English and add separate localized resources.
104104

105+
### Commit Message Standard
106+
- **Conventional Commits (REQUIRED):** This project uses the Conventional Commits specification for commit messages. Commit messages must follow the format:
107+
- <type>(<scope>): <short description>
108+
- Optionally include a longer body and/or footer for references (breaking changes, issue numbers).
109+
110+
Common types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
111+
112+
Example:
113+
- feat(cli): add `--dry-run` flag to publish command
114+
115+
Following this convention enables automated changelog generation, semantic versioning tools, and clearer git history.
116+
117+
Brief rules (self-contained):
118+
- A commit message MUST start with a type, optionally a scope, then a short description. Example: `feat(cli): add --dry-run flag`.
119+
- Types indicate the kind of change (e.g., `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`).
120+
- The scope is optional and should be a noun describing the area affected (e.g., `cli`, `docs`).
121+
- An optional body may follow after a blank line to explain motivation and other details.
122+
- Breaking changes MUST be indicated in the footer with `BREAKING CHANGE: <description>`.
123+
- Multiple line footer entries can reference issues or metadata (e.g., `Closes #123`).
124+
105125
### Testing Requirements
106126
- **Test Coverage:** Maintain high test coverage with meaningful test cases
107127
- **Test Naming:** Use descriptive test names that explain the scenario

0 commit comments

Comments
 (0)