maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docbrown/docs/getting-started/pull-request.md
rhymes 9210f6793b Improvements on dev docs (#2616) 
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -04:00

958 B
Raw Blame History

title
Preparing a Pull Request

Preparing a pull request

  • Try to keep the pull requests small. A pull request should try its very best to address only a single concern.
  • Make sure all tests pass and add additional tests for the code you submit. Checkout the testing guide.
  • Document your reasoning behind the changes. Explain why you wrote the code in the way you did. The code should be clear enough to explain what it does.
  • If there's an existing issue related to the pull request, reference to it by adding something like References/Closes/Fixes/Resolves #305, where 305 is the issue number. See GitHub's own guide on closing issues via PR.
  • If you follow the pull request template, you can't go wrong.

Please note: all commits in a pull request will be squashed when merged, but when your PR is approved and passes our CI, it will be live on production!