Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit Message Guidelines
Commit TypesBasic Structure
():
feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that don't affect code meaning (formatting, semicolons, etc.)
refactor: Code changes that neither fix bugs nor add features
perf: Code changes that improve performance
test: Adding or updating tests
chore: Build process, dependencies, or tooling changes
ci: CI/CD configuration changes
Writing Rules
Subject Line
Use imperative mood ("add" not "added" or "adds")
Don't capitalize the first letter
No period at the end
Limit to 50 characters
Be specific and descriptive
Body
Explain what and why, not how
Wrap at 72 characters
Separate from subject with a blank line
Use bullet points for multiple changes
Footer
Reference issues: Closes #123, Fixes #456
Breaking changes: BREAKING CHANGE: description
Examples
Good Commit Messages
feat(auth): add two-factor authentication
Add TOTP-based two-factor authentication for user accounts. Users can enable 2FA in their security settings and will be prompted during login.
Closes #234
fix(api): prevent race condition in user updates
The concurrent updates to the same user document could cause data loss. Added pessimistic locking to ensure sequential writes.
Fixes #789
refactor(components): simplify button styling
Extract common button styles into a shared utility class. Reduces CSS duplication by 40 lines.
Bad Commit Messages
updated stuff
fixed things
WIP
asdf
changes
Quick Reference
DoDon'tfeat: add user authenticationFeature: user authenticationfix: correct typo in email validationfixed bugUse imperative moodUse past tenseLimit subject to 50 charsWrite long subjectsExplain reasoning in bodyLeave body emptyReference issuesNo issue tracking Common Patterns
Feature with related tasks:
feat(dashboard): add analytics widgets
Closes #345
Bug fix with explanation:
fix(form): handle special characters in inputs
Special characters were causing form validation to fail. Updated the regex pattern to properly escape these characters.
Fixes #567
Refactoring:
refactor(utils): consolidate date formatting functions
Merged dateFormat and formatDate into single utility. Improved consistency and reduced code duplication.
Tips for Great Commits
Commit frequently and logically—each commit should represent one change Don't mix unrelated changes in a single commit
Write the message as if completing: "This commit will _____" Avoid generic messages like "update" or "fix"
Use the present tense consistently
Keep commits atomic—they should be reversible independently
Pre-requisites
Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.
Tasks
For all workflows, the workflow:
.ymlfile with the language or platform as its filename, in lower, kebab-cased format (for example,docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").GITHUB_TOKENso that the workflow runs successfully.For CI workflows, the workflow:
cidirectory.ci/properties/*.properties.jsonfile (for example,ci/properties/docker-publish.properties.json).pushtobranches: [ $default-branch ]andpull_requesttobranches: [ $default-branch ].releasewithtypes: [ created ].docker-publish.yml).For Code Scanning workflows, the workflow:
code-scanningdirectory.code-scanning/properties/*.properties.jsonfile (for example,code-scanning/properties/codeql.properties.json), with properties set as follows:name: Name of the Code Scanning integration.creator: Name of the organization/user producing the Code Scanning integration.description: Short description of the Code Scanning integration.categories: Array of languages supported by the Code Scanning integration.iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in theiconsdirectory.pushtobranches: [ $default-branch, $protected-branches ]andpull_requesttobranches: [ $default-branch ]. We also recommend ascheduletrigger ofcron: $cron-weekly(for example,codeql.yml).Some general notes:
actionsorganization, or