nodejs/onboarding-extras.md at e3e3588e0e9c7f59caef694a7756bb33c94c5cf7

mirror of https://github.com/nodejs/node.git synced 2024-11-30 15:30:56 +01:00

Сковорода Никита Андреевич a58b48bc3b doc: various documentation formatting fixes

* Fix markdown code sample in releases.md, it was <a id="x.y.x></a>"
* Fix some markdown errors, e.g. in changelogs
* Fix broken defs links, e.g. in domain-postmortem.md
* Fix other broken refs, by addaleax
* Add links to some defs that were present but not linked to
* Remove dead defs
* Move defs to the bottom (one file affected)
* Add language indicators to all code blocks, using `txt` when no
specific language could be chosen
* Some minor formatting changes (spaces, ident, headings)

PR-URL: https://github.com/nodejs/node/pull/7637
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>

2016-07-14 12:26:50 +03:00

4.1 KiB

Raw Blame History

Who to CC in issues

subsystem	maintainers
`benchmark/*`	@nodejs/benchmarking, @mscdex
`bootstrap_node.js`	@fishrock123
`lib/assert`	@nodejs/testing
`lib/buffer`	@nodejs/buffer
`lib/child_process`	@bnoordhuis, @cjihrig
`lib/cluster`	@bnoordhuis, @cjihrig, @mcollina
`lib/{crypto,tls,https}`	@nodejs/crypto
`lib/domains`	@misterdjules
`lib/fs`, `src/{fs	file}`
`lib/{_}http{*}`	@nodejs/http
`lib/net`	@bnoordhuis, @indutny, @nodejs/streams
`lib/{_}stream{s	*}`
`lib/repl`	@addaleax, @fishrock123
`lib/timers`	@fishrock123, @misterdjules
`lib/util`	@bnoordhuis, @cjihrig, @evanlucas
`lib/zlib`	@addaleax, @bnoordhuis, @indutny
`src/async-wrap.*`	@trevnorris
`src/node_crypto.*`	@nodejs/crypto
`test/*`	@nodejs/testing
`tools/eslint`, `.eslintrc`	@silverwind, @trott
upgrading V8	@nodejs/v8, @nodejs/post-mortem
upgrading npm	@fishrock123, @thealphanerd
upgrading c-ares	@jbergstroem
upgrading http-parser	@jbergstroem, @nodejs/http
upgrading libuv	@saghul

When things need extra attention, are controversial, or semver-major: @nodejs/ctc

If you cannot find who to cc for a file, git shortlog -n -s <file> may help.

Labels

By Subsystem

We generally sort issues by a concept of "subsystem" so that we know what part(s) of the codebase it touches.

Subsystems generally are:

lib/*.js
doc, build, tools, test, deps, lib / src (special), and there may be others.
meta for anything non-code (process) related

There may be more than one subsystem valid for any particular issue / PR.

General

Please use these when possible / appropriate

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)
good first contribution - Issues suitable for newcomers to process

semver-{minor,major}
- be conservative – that is, if a change has the remote chance of breaking something, go for semver-major
- when adding a semver label, add a comment explaining why you're adding it
- 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):
```
git checkout $(git show -s --pretty='%T' $(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')) -- test; make -j8 test
```

Other Labels

Operating system labels
- os x, windows, solaris
- No linux, linux is the implied default
Architecture labels
- arm, mips
- No x86{_64}, since that is the implied default
lts-agenda, lts-watch-v*
- tag things that should be discussed to go into LTS or should go into a specific LTS branch
- (usually only semver-patch things)
- will come more naturally over time

Updating Node.js from Upstream

git remote add upstream git://github.com/nodejs/node.git

to update from nodejs/node:

git checkout master
git remote update -p OR git fetch --all (I prefer the former)
git merge --ff-only upstream/master (or REMOTENAME/BRANCH)

If `git am` fails

if git am fails – use git am --abort
- this usually means the PR needs updated
- prefer to make the originating user update the code, since they have it fresh in mind
first, reattempt with git am -3 (3-way merge)`
if -3 still fails, and you need to get it merged:
- git fetch upstream pull/N/head:pr-N && git checkout pr-N && git rebase master

best practices

commit often, out to your github fork (origin), open a PR
when making PRs make sure to spend time on the description:
- every moment you spend writing a good description quarters the amount of time it takes to understand your code.
usually prefer to only squash at the end of your work, depends on the change

4.1 KiB Raw Blame History Unescape Escape