kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-19 18:55:14 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: elaborate on commitlint rules (#15322)

Browse Source 
linter requires lowercase at start and no period at end of description
This commit is contained in:
dundargoc 2021-08-09 18:46:33 +02:00 committed by GitHub
parent 7dbbd5d8b1
commit cad5f01cf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -89,17 +89,19 @@ the VCS/git logs more valuable. The general structure of a commit message is as
- Prefix the commit subject with one of the following _types_:
- `build`: all changes related to the build system (involving scripts, configurations or tools) and package dependencies.
- `ci`: all changes related to the continuous integration and deployment system - involving scripts, configurations or tools.
- `docs`: all documentation changes. This includes both external documentation intended for end users as well as internal documentation intended for developers.
- `docs`: all documentation changes. This includes both external documentation for users as well as internal documentation for developers.
- `feat`: new abilities or functionality.
- `fix`: a bug fix.
- `perf`: performance improvements.
- `refactor`: modification of the code base which neither adds a feature nor fixes a bug - such as removing redundant code, simplifying the code, renaming variables, etc.
- `refactor`: modification of the code base which neither adds a feature nor fixes a bug - such as removing redundant code, simplifying code, renaming variables, etc.
- `revert`: revert previous commits.
- `test`: all changes related to tests such as refactoring existing tests or adding new tests.
- `vim-patch`: all patches from upstream Vim. The commit messages for patches has [slightly different rules](https://github.com/neovim/neovim/wiki/Merging-patches-from-upstream-Vim#pull-requests) as not to interfere with existing scripts.
- `chore`: Lastly, if none of the types above fits you may use `chore` as the type.
- Append optional scope to _type_ if possible: `(lsp)`, `(treesitter)` or `(float/windows)`.
- Append optional scope to _type_ such as `(lsp)`, `(treesitter)`, `(float)`, ...
- The _description_ shouldn't start with a capital letter or end in a period.
- Try to keep the first line under 72 characters.