https://github.com/serenepixel/git-keywords
Keywords used in your commit message to clearly indicate the type of change being made
https://github.com/serenepixel/git-keywords
git github gitmessage
Last synced: 3 months ago
JSON representation
Keywords used in your commit message to clearly indicate the type of change being made
- Host: GitHub
- URL: https://github.com/serenepixel/git-keywords
- Owner: serenepixel
- Created: 2025-02-12T17:02:20.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T17:28:46.000Z (12 months ago)
- Last Synced: 2025-09-13T21:46:48.697Z (4 months ago)
- Topics: git, github, gitmessage
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Git Commit Message Keywords
When contributing to any project, use the following keywords in your commit messages to clearly indicate the type of change being made:
* **`feat`:** Introduces a new feature. Example: `feat: Add user authentication`
* **`fix`:** Addresses a bug or issue. Example: `fix: Resolve issue with broken link on homepage`
* **`style`:** Changes the code style or formatting (no functional changes). Example: `style: Enforce consistent indentation across codebase`
* **`refactor`:** Improves code structure or organization without adding features or fixing bugs. Example: `refactor: Extract database connection logic into separate module`
* **`add`:** Creates a new capability (feature, test, dependency, etc.). Example: `add: Implement unit tests for data validation`
* **`drop`:** Removes a capability (feature, test, dependency, etc.). Example: `drop: Remove unused analytics library`
* **`bump`:** Increases the version of a dependency or tool. Example: `bump: Upgrade React version to 18.2`
* **`make`:** Changes to the build process, tools, or infrastructure. Example: `make: Update webpack configuration for production builds`
* **`start`:** Begins a process or enables a feature (e.g., a toggle or feature flag). Example: `start: Enable new payment processing system`
* **`stop`:** Ends a process or disables a feature (e.g., a toggle or feature flag). Example: `stop: Disable deprecated API endpoint`
* **`optimize`:** A performance-focused change that improves speed or efficiency. Example: `optimize: Improve query performance for user profiles`
* **`document` or `docs`:** Changes related solely to documentation. Example: `docs: Update API documentation for new endpoint`
* **`chore`:** General maintenance tasks, dependency upgrades, etc. Example: `chore: Update dependencies to latest versions`
* **`test`:** Changes related to adding or correcting tests. Example: `test: Add integration tests for payment processing`
**Linking to Issues/Work Items:**
If your commit relates to a specific issue or work item in the tracking system, include the issue ID in the commit message (e.g., `fix: Resolve issue #123 - User profile update error`).