Skip to content

Commit e508bdc

Browse files
authored
docs: contributing: PR subject (#2726)
* docs: contributing: PR subject * docs: contributing: PR subject
1 parent e20966a commit e508bdc

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,31 @@ When adding or changing API please update :help nvim-tree-api
8181

8282
# Pull Request
8383

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

8686
Please check "allow edits by maintainers" to allow nvim-tree developers to make small changes such as documentation tweaks.
8787

88-
A test case to reproduce the issue is required. A ["Clean Room" Replication](https://github.com/nvim-tree/nvim-tree.lua/wiki/Troubleshooting#clean-room-replication) is preferred.
88+
## Subject
8989

90+
The merge commit message will be the subject of the PR.
91+
92+
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.
93+
94+
`fix(#2395): marks.bulk.move defaults to directory at cursor`
95+
96+
Available types:
97+
* feat: A new feature
98+
* fix: A bug fix
99+
* docs: Documentation only changes
100+
* style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
101+
* refactor: A code change that neither fixes a bug nor adds a feature
102+
* perf: A code change that improves performance
103+
* test: Adding missing tests or correcting existing tests
104+
* build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
105+
* ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
106+
* chore: Other changes that don't modify src or test files
107+
* revert: Reverts a previous commit
108+
109+
If in doubt, look at previous commits.
110+
111+
See also [The Conventional Commits ultimate cheatsheet](https://gist.github.com/gabrielecanepa/fa6cca1a8ae96f77896fe70ddee65527)

0 commit comments

Comments
 (0)