mirror of
https://github.com/kha7iq/pingme.git
synced 2025-05-15 14:20:18 -07:00
docs: add details about commit messages
This commit is contained in:
parent
5d0e6efc40
commit
f6a7d22c81
@ -21,6 +21,7 @@ possible.
|
||||
- Checking Locally
|
||||
- Docsify is used for documentation rendering from markdown, you can download
|
||||
the cli and test locally before opening a pull request.
|
||||
|
||||
Install
|
||||
```bash
|
||||
npm i docsify-cli -g
|
||||
@ -37,6 +38,18 @@ possible.
|
||||
Commit messages should be well formatted, and to make that "standardized", we
|
||||
are using Conventional Commits.
|
||||
|
||||
```shell
|
||||
|
||||
<type>[<scope>]: <short summary>
|
||||
│ │ │
|
||||
│ │ └─> Summary in present tense. Not capitalized. No period at the end.
|
||||
│ │
|
||||
│ └─> Scope (optional): eg. common, compiler, authentication, core
|
||||
│
|
||||
└─> Type: chore, docs, feat, fix, refactor, style, or test.
|
||||
|
||||
```
|
||||
|
||||
You can follow the documentation on
|
||||
[their website](https://www.conventionalcommits.org).
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user