Skip to content

Commit

Permalink
docs: Update commit message guidelines for clarity and conciseness 📜
Browse files Browse the repository at this point in the history
  • Loading branch information
0GiS0 committed Dec 29, 2024
1 parent 0b4edee commit f42dd1e
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
## Commit messages
The key to a good commit is clarity and conciseness. If the commit is for a new feature should start with `feat: `, if it's for fixing a bug should start with `fix: `, if it's for performance improvements should start with `perf: `, if its for style or layout changes should start with `style: `, for minimum changes with no significant impact `chore: ` and for documentation `docs: `. The most important thing it to keep the messages clear and precise so that everyone working on the project can quickly understand the changes made.

3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
},
{
"text": "Add emoji at the end of the message."
},
{
"file": "docs/code-style copy.md"
}
],
"github.copilot.chat.testGeneration.instructions": [
Expand Down
2 changes: 2 additions & 0 deletions docs/code-style copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## Commit messages
The key to a good commit is clarity and conciseness. If the commit is for a new feature should start with `feat: `, if it's for fixing a bug should start with `fix: `, if it's for performance improvements should start with `perf: `, if its for style or layout changes should start with `style: `, for minimum changes with no significant impact `chore: ` and for documentation `docs: `. The most important thing it to keep the messages clear and precise so that everyone working on the project can quickly understand the changes made.

0 comments on commit f42dd1e

Please sign in to comment.