azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rework and move the pull request checklist to a new section in ReadMe

Browse Source 
Otherwise this text appears in numerous pull requests and contributors
do not understand what to do with it
This commit is contained in:
Alexander Udalov
2018-08-02 13:51:00 +02:00
parent 4c7bdf5437
commit ccb6410823
2 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/PULL_REQUEST_TEMPLATE.md
-14
View File
@@ -1,14 +0,0 @@
Many thanks for your contribution, we genuinely appreciate it.
Make sure that you can say "YES" to each point in this short checklist:
- You do not have merge commits in PR
- You made a few changes
- You provided the link to related issue from YouTrack
- You can describe changes made in PR
- You made changes related to only one issue
- You are ready to defend your changes on code review
- You didn't touch what you don't understand
- You ran the build locally, and verified new functionality
- You ran related tests locally, and it passed
Thank you for your contribution!
ReadMe.md
+13 -2
View File
@@ -159,8 +159,8 @@ If you want to contribute a new language feature, it is important to discuss it
## Submitting patches ## Submitting patches
The best way to submit a patch is to [fork the project on github](https://help.github.com/articles/fork-a-repo/) then send us a The best way to submit a patch is to [fork the project on GitHub](https://help.github.com/articles/fork-a-repo/) and then send us a
[pull request](https://help.github.com/articles/creating-a-pull-request/) via [github](https://github.com). [pull request](https://help.github.com/articles/creating-a-pull-request/) via [GitHub](https://github.com).
If you create your own fork, it might help to enable rebase by default If you create your own fork, it might help to enable rebase by default
when you pull by executing when you pull by executing
@@ -169,3 +169,14 @@ git config --global pull.rebase true
``` ```
This will avoid your local repo having too many merge commits This will avoid your local repo having too many merge commits
which will help keep your pull request simple and easy to apply. which will help keep your pull request simple and easy to apply.
## Checklist
Before submitting the pull request, make sure that you can say "YES" to each point in this short checklist:
- You provided the link to the related issue(s) from YouTrack
- You made a reasonable amount of changes related only to the provided issues
- You can explain changes made in the pull request
- You ran the build locally and verified new functionality
- You ran related tests locally and they passed
- You do not have merge commits in the pull request