f7d928506a
- Implemented popup.html for user interface with search functionality and request display. - Developed popup.js to manage search items, matched requests, and clipboard operations. - Created mergeConflictManager.js for automated git operations in specified repositories. - Added projects.txt to maintain a list of relevant projects. - Introduced pushReleaseBranches.js for managing release branches across multiple projects. - Developed releasePrepper.js to prepare projects for release with branch management. - Created stashUpdater.js to update git origins for projects. - Added updatedProjects.txt to track projects that have been updated.
63 lines
1.4 KiB
Markdown
63 lines
1.4 KiB
Markdown
# Commit Message Instructions
|
|
|
|
## Purpose
|
|
|
|
To ensure all commit messages are traceable to their corresponding ticket, **every commit message must begin with the ticket identifier**. The ticket identifier is always found after the last `/` in your branch name.
|
|
|
|
---
|
|
|
|
## Commit Message Format
|
|
|
|
```
|
|
<TICKET-ID> - <concise, descriptive summary of the change>
|
|
|
|
[Optional: longer description, rationale, or context]
|
|
```
|
|
|
|
**Example:**
|
|
|
|
If your branch is named:
|
|
`feature/ABC-1234-add-login-form`
|
|
|
|
Your commit message **must start with**:
|
|
`ABC-1234 - ...`
|
|
|
|
**Good:**
|
|
```
|
|
ABC-1234 - Add login form component and validation
|
|
```
|
|
|
|
**Bad:**
|
|
```
|
|
Add login form component and validation
|
|
```
|
|
|
|
---
|
|
|
|
## How to Find the Ticket ID
|
|
|
|
- The ticket ID is the text after the last `/` in your branch name.
|
|
- Examples:
|
|
- `bugfix/DEF-5678-fix-header` → `DEF-5678`
|
|
- `feature/XYZ-9999-new-dashboard` → `XYZ-9999`
|
|
|
|
---
|
|
|
|
## Additional Guidelines
|
|
|
|
- Use the imperative mood (“Add”, “Fix”, “Update”, not “Added”, “Fixed”, “Updated”).
|
|
- Keep the summary under 72 characters.
|
|
- Reference additional tickets or context in the body if needed.
|
|
- For multiple commits, each must start with the ticket ID.
|
|
|
|
---
|
|
|
|
## Rationale
|
|
|
|
- Ensures traceability between code changes and tickets.
|
|
- Makes it easy to search and filter commits by ticket.
|
|
- Supports automated tooling and release notes generation.
|
|
|
|
---
|
|
|
|
**Commits that do not follow this format may be rejected by code review or CI.** |