mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 07:53:06 +01:00
Code Issues Releases Activity
ffc708daad
nodejs/.github/PULL_REQUEST_TEMPLATE.md

34 lines
1.0 KiB
Markdown
Raw Normal View History

doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
<!--
Thank you for submitting a pull request to Node.js. Before you submit, please
review below requirements and walk through the checklist. You can 'tick'
a box by using the letter "x": [x].
github: add issue and pull request templates Fix: #5246 PR-URL: https://github.com/nodejs/node/pull/5291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-02-17 21:48:00 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
Run the test suite by invoking: `make -j4 lint test` on linux or
`vcbuild test nosign` on Windows.
github: add issue and pull request templates Fix: #5246 PR-URL: https://github.com/nodejs/node/pull/5291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-02-17 21:48:00 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
If this aims to fix a regression or you’re adding a feature, make sure you also
write a test. Finally – if possible – a benchmark that quantifies your changes.
github: add issue and pull request templates Fix: #5246 PR-URL: https://github.com/nodejs/node/pull/5291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-02-17 21:48:00 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
Finally, read through our contributors guide and make adjustments as necessary:
https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
-->
github: add issue and pull request templates Fix: #5246 PR-URL: https://github.com/nodejs/node/pull/5291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-02-17 21:48:00 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
##### Checklist
github: add issue and pull request templates Fix: #5246 PR-URL: https://github.com/nodejs/node/pull/5291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-02-17 21:48:00 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
<!-- remove lines that do not apply to you -->
github: add issue and pull request templates Fix: #5246 PR-URL: https://github.com/nodejs/node/pull/5291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-02-17 21:48:00 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
- [ ] tests and code linting passes
- [ ] a test and/or benchmark is included
- [ ] documentation is changed or added
- [ ] the commit message follows commit guidelines
github: put description of PR to the end of tmpl It looks like github appends commit log right after the template contents. Seeing this it does not look logical to ask for details first. This commit puts `Description of change` part to the end of the template. PR-URL: https://github.com/nodejs/node/pull/5378 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-02-23 06:38:24 +01:00
doc: improve github templates by using comments Use HTML comments to reduce potential noise in github templates. Also, improve flow of the pull request, making it easier to read. PR-URL: https://github.com/nodejs/node/pull/5710 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-03-15 06:06:09 +01:00
##### Affected core subsystem(s)
<!-- provide affected core subsystem(s) (like doc, cluster, crypto, etc) -->
##### Description of change
<!-- provide a description of the change below this comment -->
Copy Permalink