CONTRIBUTING.org: require a changelog entry from new PRs
Add a section in CONTRIBUTING.org mandating a changelog entry in every PR. This is done to share the workload of maintainers and streamline the merge process as suggested by @kain88-de in #8686.
This commit is contained in:
parent
4c231ae282
commit
909d89f16b
|
@ -19,6 +19,7 @@ Thanks! :heart: :heart: :heart:
|
||||||
- [[#general-contribution-guidelines][General contribution guidelines]]
|
- [[#general-contribution-guidelines][General contribution guidelines]]
|
||||||
- [[#license][License]]
|
- [[#license][License]]
|
||||||
- [[#conventions][Conventions]]
|
- [[#conventions][Conventions]]
|
||||||
|
- [[#changelog-entry][Changelog entry]]
|
||||||
- [[#pull-request][Pull Request]]
|
- [[#pull-request][Pull Request]]
|
||||||
- [[#ideally-for-simple-prs-most-of-them][Ideally for /simple/ PRs (most of them):]]
|
- [[#ideally-for-simple-prs-most-of-them][Ideally for /simple/ PRs (most of them):]]
|
||||||
- [[#for-complex-prs-big-refactoring-etc][For complex PRs (big refactoring, etc):]]
|
- [[#for-complex-prs-big-refactoring-etc][For complex PRs (big refactoring, etc):]]
|
||||||
|
@ -86,6 +87,14 @@ Spacemacs is based on conventions, mainly for naming functions, keybindings
|
||||||
definition and writing documentation. Please read the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/CONVENTIONS.org][CONVENTIONS.org]] file
|
definition and writing documentation. Please read the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/CONVENTIONS.org][CONVENTIONS.org]] file
|
||||||
before your first contribution to get to know them.
|
before your first contribution to get to know them.
|
||||||
|
|
||||||
|
*** Changelog entry
|
||||||
|
Add a short entry describing your proposed change under a suitable subheading in
|
||||||
|
[[https://github.com/syl20bnr/spacemacs/blob/develop/CHANGELOG.develop][CHANGELOG.develop]]. Use the previous entries and [[https://github.com/syl20bnr/spacemacs/blob/develop/CONTRIBUTING.org#commit-messages][commit messages instructions]] as
|
||||||
|
guidelines. You can add your name or github username in parentheses at the end
|
||||||
|
of the entry if you want to. If an entry already exists describing your PR
|
||||||
|
(small documentation improvements etc.), you can omit the changelog entry or add
|
||||||
|
your name at the end of the pre-existing one.
|
||||||
|
|
||||||
*** Pull Request
|
*** Pull Request
|
||||||
Submit your contribution against the =develop= branch. You should not use
|
Submit your contribution against the =develop= branch. You should not use
|
||||||
your =master= branch to modify Spacemacs, this branch is considered to be
|
your =master= branch to modify Spacemacs, this branch is considered to be
|
||||||
|
|
Loading…
Reference in a new issue