2016-09-20 06:54:35 +02:00
|
|
|
|
# Additional Onboarding Information
|
|
|
|
|
|
2015-11-09 23:52:43 +01:00
|
|
|
|
## Labels
|
|
|
|
|
|
2018-03-09 01:32:17 +01:00
|
|
|
|
### Subsystems
|
2015-11-09 23:52:43 +01:00
|
|
|
|
|
2018-03-06 05:56:49 +01:00
|
|
|
|
* `lib/*.js` (`assert`, `buffer`, etc.)
|
|
|
|
|
* `build`
|
|
|
|
|
* `doc`
|
|
|
|
|
* `lib / src`
|
|
|
|
|
* `test`
|
|
|
|
|
* `tools`
|
2015-11-09 23:52:43 +01:00
|
|
|
|
|
2018-03-06 05:56:49 +01:00
|
|
|
|
There may be more than one subsystem valid for any particular issue or pull
|
|
|
|
|
request.
|
2015-11-09 23:52:43 +01:00
|
|
|
|
|
|
|
|
|
### General
|
|
|
|
|
|
|
|
|
|
* `confirmed-bug` - Bugs you have verified exist
|
|
|
|
|
* `discuss` - Things that need larger discussion
|
|
|
|
|
* `feature request` - Any issue that requests a new feature (usually not PRs)
|
2017-10-11 20:24:14 +02:00
|
|
|
|
* `good first issue` - Issues suitable for newcomers to process
|
2018-03-06 05:56:49 +01:00
|
|
|
|
* `meta` - For issues whose topic is governance, policies, procedures, etc.
|
2015-11-09 23:52:43 +01:00
|
|
|
|
|
2016-05-09 17:39:48 +02:00
|
|
|
|
--
|
|
|
|
|
|
2015-11-09 23:52:43 +01:00
|
|
|
|
* `semver-{minor,major}`
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* be conservative – that is, if a change has the remote *chance* of breaking
|
|
|
|
|
something, go for semver-major
|
2015-11-09 23:52:43 +01:00
|
|
|
|
* when adding a semver label, add a comment explaining why you're adding it
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* minor vs. patch: roughly: "does it add a new method / does it add a new
|
|
|
|
|
section to the docs"
|
|
|
|
|
* major vs. everything else: run last versions tests against this version, if
|
|
|
|
|
they pass, **probably** minor or patch
|
|
|
|
|
* A breaking change helper
|
|
|
|
|
([full source](https://gist.github.com/chrisdickinson/ba532fa0e4e243fb7b44)):
|
2016-07-09 07:13:09 +02:00
|
|
|
|
```sh
|
2017-12-17 16:59:46 +01:00
|
|
|
|
SHOW=$(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')
|
|
|
|
|
git checkout $(git show -s --pretty='%T' $SHOW) -- test
|
|
|
|
|
make -j4 test
|
2015-11-09 23:52:43 +01:00
|
|
|
|
```
|
|
|
|
|
|
2017-04-15 22:05:00 +02:00
|
|
|
|
### LTS/Version labels
|
|
|
|
|
|
|
|
|
|
We use labels to keep track of which branches a commit should land on:
|
|
|
|
|
|
|
|
|
|
* `dont-land-on-v?.x`
|
|
|
|
|
* For changes that do not apply to a certain release line
|
|
|
|
|
* Also used when the work of backporting a change outweighs the benefits
|
|
|
|
|
* `land-on-v?.x`
|
|
|
|
|
* Used by releasers to mark a PR as scheduled for inclusion in an LTS release
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* Applied to the original PR for clean cherry-picks, to the backport PR
|
|
|
|
|
otherwise
|
2017-04-15 22:05:00 +02:00
|
|
|
|
* `backport-requested-v?.x`
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* Used to indicate that a PR needs a manual backport to a branch in order to
|
|
|
|
|
land the changes on that branch
|
|
|
|
|
* Typically applied by a releaser when the PR does not apply cleanly or it
|
|
|
|
|
breaks the tests after applying
|
2017-04-15 22:05:00 +02:00
|
|
|
|
* Will be replaced by either `dont-land-on-v?.x` or `backported-to-v?.x`
|
|
|
|
|
* `backported-to-v?.x`
|
|
|
|
|
* Applied to PRs for which a backport PR has been merged
|
|
|
|
|
* `lts-watch-v?.x`
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* Applied to PRs which the LTS working group should consider including in a
|
|
|
|
|
LTS release
|
|
|
|
|
* Does not indicate that any specific action will be taken, but can be
|
|
|
|
|
effective as messaging to non-collaborators
|
2017-04-15 22:05:00 +02:00
|
|
|
|
* `lts-agenda`
|
|
|
|
|
* For things that need discussion by the LTS working group
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* (for example semver-minor changes that need or should go into an LTS
|
|
|
|
|
release)
|
2017-04-15 22:05:00 +02:00
|
|
|
|
* `v?.x`
|
2017-12-17 16:59:46 +01:00
|
|
|
|
* Automatically applied to changes that do not target `master` but rather the
|
|
|
|
|
`v?.x-staging` branch
|
2017-04-15 22:05:00 +02:00
|
|
|
|
|
|
|
|
|
Once a release line enters maintenance mode, the corresponding labels do not
|
|
|
|
|
need to be attached anymore, as only important bugfixes will be included.
|
2015-11-09 23:52:43 +01:00
|
|
|
|
|
|
|
|
|
### Other Labels
|
|
|
|
|
|
|
|
|
|
* Operating system labels
|
2016-10-11 09:31:57 +02:00
|
|
|
|
* `macos`, `windows`, `smartos`, `aix`
|
2015-11-09 23:52:43 +01:00
|
|
|
|
* No linux, linux is the implied default
|
|
|
|
|
* Architecture labels
|
2016-10-10 15:46:04 +02:00
|
|
|
|
* `arm`, `mips`, `s390`, `ppc`
|
2015-11-09 23:52:43 +01:00
|
|
|
|
* No x86{_64}, since that is the implied default
|