Skip to content

Commit 6207912

Browse files
authored
docs: contributing: PR subject (#430)
1 parent 6662f05 commit 6207912

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,6 @@
22

33
Thank you for your contribution!
44

5-
## Name
6-
7-
Please name your commits and the PR simply e.g.
8-
9-
add .tex
10-
update makefile icon
11-
update .kt colors
12-
135
## Order
146

157
Please ensure `icons_by_filename`, `icons_by_file_extension` and `filetypes` are ordered alphabetically, to prevent merge conflicts.
@@ -92,12 +84,41 @@ Start neovim with `TERM=xterm-256color nvim ...` to test cterm.
9284

9385
Check with `&background` `dark` and `light`
9486

95-
## Pull Request
87+
## Documentation
88+
89+
When modifying or adding API, please update [Usage](README.md#Usage)
90+
91+
# Pull Request
9692

97-
Please reference any issues in the description e.g. "resolves #1234".
93+
Please reference any issues in the description e.g. "resolves #1234", which will be closed upon merge.
9894

9995
Please check "allow edits by maintainers" to allow nvim-web-devicons maintainers to make small changes such as documentation tweaks.
10096

101-
## Documentation
97+
## Subject
10298

103-
When modifying or adding API, please update [Usage](README.md#Usage)
99+
The merge commit message will be the subject of the PR.
100+
101+
A [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) subject will be validated by the Semantic Pull Request Subject CI job. Reference the issue to be used in the release notes e.g.
102+
103+
```
104+
feat: add gradle icons
105+
fix: update rust icon
106+
feat(#192): :NvimWebDeviconsHiTest
107+
```
108+
109+
Available types:
110+
* feat: A new feature
111+
* fix: A bug fix
112+
* docs: Documentation only changes
113+
* style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
114+
* refactor: A code change that neither fixes a bug nor adds a feature
115+
* perf: A code change that improves performance
116+
* test: Adding missing tests or correcting existing tests
117+
* build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
118+
* ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
119+
* chore: Other changes that don't modify src or test files
120+
* revert: Reverts a previous commit
121+
122+
If in doubt, look at previous commits.
123+
124+
See also [The Conventional Commits ultimate cheatsheet](https://gist.github.com/gabrielecanepa/fa6cca1a8ae96f77896fe70ddee65527)

0 commit comments

Comments
 (0)