Browse Source

doc: update COLLABORATOR_GUIDE.md

PR-URL: https://github.com/nodejs/node/pull/12555
Fixes: https://github.com/nodejs/node/issues/12021
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
v6.x
morrme 8 years ago
committed by Myles Borins
parent
commit
b31e6dfef5
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
  1. 22
      COLLABORATOR_GUIDE.md

22
COLLABORATOR_GUIDE.md

@ -4,6 +4,7 @@
* [Issues and Pull Requests](#issues-and-pull-requests) * [Issues and Pull Requests](#issues-and-pull-requests)
* [Accepting Modifications](#accepting-modifications) * [Accepting Modifications](#accepting-modifications)
- [Useful CI Jobs](#useful-ci-jobs)
- [Internal vs. Public API](#internal-vs-public-api) - [Internal vs. Public API](#internal-vs-public-api)
- [Breaking Changes](#breaking-changes) - [Breaking Changes](#breaking-changes)
- [Deprecations](#deprecations) - [Deprecations](#deprecations)
@ -87,6 +88,27 @@ All pull requests that modify executable code should be subjected to
continuous integration tests on the continuous integration tests on the
[project CI server](https://ci.nodejs.org/). [project CI server](https://ci.nodejs.org/).
#### Useful CI Jobs
* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`,
which runs the `build-ci` and `test-ci` targets on all supported platforms.
* [`node-test-linter`](https://ci.nodejs.org/job/node-test-linter/)
only runs the linter targets, which is useful for changes that only affect comments
or documentation.
* [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/)
uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test`
on a large selection of common modules. This is useful to check whether a
change will cause breakage in the ecosystem. To test Node.JS ABI changes
you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
* [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/)
is designed to allow one to run a group of tests over and over on a specific
platform to confirm that the test is reliable.
### Internal vs. Public API ### Internal vs. Public API
Due to the nature of the JavaScript language, it can often be difficult to Due to the nature of the JavaScript language, it can often be difficult to

Loading…
Cancel
Save