Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 17:50:04 +08:00
Code Issues Projects Releases Wiki Activity

Improve pull request template

Browse Source
This commit is contained in:
wsdjeg 2018-06-20 21:22:35 +08:00
parent de460cf5af
commit 67153b668d
3 changed files with 41 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -2,18 +2,13 @@
Thank you for working on SpaceVim! :) Thank you for working on SpaceVim! :)
**Please complete these steps and check these boxes (by putting an `x` inside Please complete these steps and check these boxes before filing your PR:
the brackets) _before_ filing your PR:**
- [ ] I have read and understood SpaceVim's [CONTRIBUTING][cont] document. - [ ] I have read and understood SpaceVim's [CONTRIBUTING](https://github.com/SpaceVim/SpaceVim/blob/master/CONTRIBUTING.md) document.
- [ ] I have read and understood SpaceVim's [CODE_OF_CONDUCT][code] document. - [ ] I have read and understood SpaceVim's [CODE_OF_CONDUCT](https://github.com/SpaceVim/SpaceVim/blob/master/CODE_OF_CONDUCT.md) document.
- [ ] I have updated the [Following-HADE](follow) page for this PR. - [ ] I have updated the [Following-HADE](https://github.com/SpaceVim/SpaceVim/blob/master/wiki/en/Following-HEAD.md) page for this PR.
- [ ] **I understand my PR may be closed if it becomes obvious I didn't actually perform all of these steps.** - [ ] I understand my PR may be closed if it becomes obvious I didn't actually perform all of these steps.
### Why this change is necessary and useful ### Why this change is necessary and useful?
[Please explain **in detail** why the changes in this PR are needed.] [Please explain **in detail** why the changes in this PR are needed.]
[cont]: https://github.com/SpaceVim/SpaceVim/blob/master/CONTRIBUTING.md
[code]: https://github.com/SpaceVim/SpaceVim/blob/master/CODE_OF_CONDUCT.md
[follow]: https://github.com/SpaceVim/SpaceVim/blob/master/wiki/en/Following-HEAD.md

22
CONTRIBUTING.md
View File

@ -10,22 +10,21 @@ We have a few guidelines, which we ask all contributors to follow.
You need only consider reading the sections relevant to what you are going to do: You need only consider reading the sections relevant to what you are going to do:
- [Asking for help](#asking-for-help) if you are about to open an issue to ask a question. - [Asking for help](#asking-for-help) if you are about to ask an usage question.
- [Reporting issues](#reporting-issues) if you are about to open a new issue. - [Reporting issues](#reporting-issues) if you are about to open a new issue.
- [Contributing code](#contributing-code) if you are about to send a Pull Request (PR). - [Contributing code](#contributing-code) if you are about to send a Pull Request (PR).
### Asking for help ### Asking for help
If you want to ask an usage question, be sure to look first into some places as it may hold the answers: If you want to ask an usage question, be sure to look first into some places as it may hold the answers:
- <kbd>:h SpaceVim-faq</kbd>: Some of the most frequently asked questions are answered there. - [FAQ](https://spacevim.org/faq/): Some of the most frequently asked questions are answered there.
- [SpaceVim documentation](https://spacevim.org/documentation): It is the general documentation of SpaceVim. - [documentation](https://spacevim.org/documentation/): It is the general documentation of SpaceVim.
- [gitter room](https://gitter.im/SpaceVim/SpaceVim): The official channel of SpaceVim.
### Reporting issues ### Reporting issues
Issues have to be reported on [issues tracker](https://github.com/SpaceVim/SpaceVim/issues), Please: Issues have to be reported on [issues tracker](https://github.com/SpaceVim/SpaceVim/issues), Please:
- Check the **[FAQ](https://github.com/SpaceVim/SpaceVim/wiki/FAQ)**.
- Search existing issues (including closed!) - Search existing issues (including closed!)
- Update SpaceVim to the latest version to see if your problem persists. - Update SpaceVim to the latest version to see if your problem persists.
- Use a clear title and follow the issue template. - Use a clear title and follow the issue template.
@ -33,7 +32,9 @@ Issues have to be reported on [issues tracker](https://github.com/SpaceVim/Space
### Contributing code ### Contributing code
Code contributions are welcome. Please read the following sections carefully. In any case, feel free to join us on the [gitter chat](https://gitter.im/SpaceVim/SpaceVim) to ask questions about contributing! Code contributions are welcome. Please read the following sections carefully.
In any case, feel free to join us on the [gitter room](https://gitter.im/SpaceVim/SpaceVim) to ask
questions about contributing!
#### License #### License
@ -43,15 +44,18 @@ The license is GPLv3 for all the parts of SpaceVim. this includes:
- All the layer files. - All the layer files.
- The documentation - The documentation
For files not belonging to SpaceVim, such as local packages and libraries, refer to the header file. Those files should not have an empty header. We may not accept code without a proper header file. For files not belonging to SpaceVim, such as local packages and libraries, refer to the header file.
Those files should not have an empty header. We may not accept code without a proper header file.
#### Conventions #### Conventions
SpaceVim is based on conventions, mainly for naming functions, keybindings definition and writing documentation. Please read the [conventions](https://spacevim.org/conventions/) before your first contribution to get to know them. SpaceVim is based on conventions, mainly for naming functions, keybindings definition and writing
documentation. Please read the [conventions](https://spacevim.org/conventions/) before your first contribution to get to know them.
#### Pull Request #### Pull Request
Submit your contribution against the `master` branch. You should not use your master branch to modify SpaceVim, this branch is considered to be read-only. Submit your contribution against the `master` branch. You should not use your master branch
to modify SpaceVim, this branch is considered to be read-only.
You may want to read our [development guidelines](https://spacevim.org/development/). You may want to read our [development guidelines](https://spacevim.org/development/).

29
docs/development.md
View File

@ -14,9 +14,10 @@ description: "General contributing guidelines and changelog of SpaceVim, includi
- [Bootstrap](#bootstrap) - [Bootstrap](#bootstrap)
- [Conventions](#conventions) - [Conventions](#conventions)
- [Pull Request](#pull-request) - [Pull Request](#pull-request)
- [Rebase your pr Branch on top of upstream master:](#rebase-your-pr-branch-on-top-of-upstream-master) - [Title prefix of pull request](#title-prefix-of-pull-request)
- [Ideally for simple PRs (most of them):](#ideally-for-simple-prs-most-of-them) - [Rebase on top of upstream master](#rebase-on-top-of-upstream-master)
- [For complex PRs (big refactoring, etc):](#for-complex-prs-big-refactoring-etc) - [Ideally for simple PRs](#ideally-for-simple-prs)
- [For complex PRs](#for-complex-prs)
- [Contributing a layer](#contributing-a-layer) - [Contributing a layer](#contributing-a-layer)
- [File header](#file-header) - [File header](#file-header)
- [Author of a new layer](#author-of-a-new-layer) - [Author of a new layer](#author-of-a-new-layer)
@ -47,7 +48,7 @@ You can only consider reading the sections relevant to what you are going to do:
If you want to ask an usage question, be sure to look first into some places as it may hold the answers: If you want to ask an usage question, be sure to look first into some places as it may hold the answers:
- <kbd>:h SpaceVim-faq</kbd>: Some of the most frequently asked questions are answered there. - <kbd>:h SpaceVim-faq</kbd>: Some of the most frequently asked questions are answered there.
- [SpaceVim documentation](https://spacevim.org/documentation): It is the general documentation of SpaceVim. - [SpaceVim documentation](https://spacevim.org/documentation/): It is the general documentation of SpaceVim.
## Reporting issues ## Reporting issues
@ -84,7 +85,21 @@ SpaceVim is based on conventions, mainly for naming functions, keybindings defin
### Pull Request ### Pull Request
#### Rebase your pr Branch on top of upstream master: #### Title prefix of pull request
pull request title should contains one of these prefix:
- `Add:` Adding a new feature.
- `Change:` Change default behaviors or the existing features.
- `Remove:` Remove any existing features.
- `Doc:` update the help file.
- `Website:` Update the contend of website.
here is an example:
`Website: update the lang#c layer page`
#### Rebase on top of upstream master
- fork SpaceVim repository - fork SpaceVim repository
- clone your repository - clone your repository
@ -106,7 +121,7 @@ git fetch upstream
git rebase upstream/master master git rebase upstream/master master
``` ```
#### Ideally for simple PRs (most of them): #### Ideally for simple PRs
- Branch from `master` - Branch from `master`
- One topic per PR - One topic per PR
@ -114,7 +129,7 @@ git rebase upstream/master master
- If you have several commits on different topics, close the PR and create one PR per topic - If you have several commits on different topics, close the PR and create one PR per topic
- If you still have several commits, squash them into only one commit - If you still have several commits, squash them into only one commit
#### For complex PRs (big refactoring, etc): #### For complex PRs
Squash only the commits with uninteresting changes like typos, syntax fixes, etc… and keep the important and isolated steps in different commits. Squash only the commits with uninteresting changes like typos, syntax fixes, etc… and keep the important and isolated steps in different commits.