summaryrefslogtreecommitdiff
path: root/COLLABORATOR_GUIDE.md
AgeCommit message (Collapse)Author
2019-11-25doc: document "Resume Build" limitationRichard Lau
Compiled binaries for fanned CI builds on Windows and ARM are only kept for seven days. PR-URL: https://github.com/nodejs/node/pull/30604 Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-11-20doc: explain GIT_REMOTE_REF in COLLABORATOR_GUIDEDenys Otrishko
PR-URL: https://github.com/nodejs/node/pull/30371 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-11-17doc: document timed out Travis CI buildsRichard Lau
PR-URL: https://github.com/nodejs/node/pull/30469 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>
2019-11-10doc,meta: allow Travis results for doc/comment changesRich Trott
Permit the use of Travis CI results for pull requests that only change documentation or comments. This also removes node-test-pull-request-lite-pipeline from the documentation. Efforts to move all CI jobs to pipelines have stalled and it's not clear that our current Jenkins admins are enthusiastic about pipelines. PR-URL: https://github.com/nodejs/node/pull/30330 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-10-30doc,meta: prefer aliases and stubs over Runtime DeprecationsRich Trott
Avoid Runtime Deprecations when an alias or a stub/no-op will suffice. An alias or stub will have lower maintenance costs for end users. Refs: https://github.com/nodejs/node/pull/29989#issuecomment-545427805 PR-URL: https://github.com/nodejs/node/pull/30153 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2019-10-02doc: remove reference to stale CITGM jobMichael Dawson
Remove reference to job that is out of date, has not been run for a long time and likely does not work properly. Refs: https://github.com/nodejs/citgm/issues/741 PR-URL: https://github.com/nodejs/node/pull/29774 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-09-16doc: use consistent unordered list styleNick Schonning
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: https://github.com/nodejs/node/pull/29516 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-09-09doc: space around listsNick Schonning
Address markdownlint rule MD032. Flagged a few mixed list styles. PR-URL: https://github.com/nodejs/node/pull/29467 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-09-02doc: escape elements swallowed as HTML in markdownNick Schonning
Addresses Markdownlint MD033 issues. Altering changlog should usually be avoided, but they don't render currently. PR-URL: https://github.com/nodejs/node/pull/29374 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-06-18doc: remove instructions to post CI linksRich Trott
Remove instructions (in the Collaborator Guide) to post CI links. The bot does that now. PR-URL: https://github.com/nodejs/node/pull/28248 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-03-30doc: remove "How is an LTS release cut?" sectionRich Trott
The release process is in the Release plan, linked earlier in the doc. Don't include information here because duplicated information is likely to drift apart, resulting in contradictions and a lack of clarity about which document is correct. (I think the text removed is already out-of-date. I could be wrong, and it doesn't much matter, as it should be removed anyway.) It's also not entirely clear what the utility/relevance of this information is in this particular document. PR-URL: https://github.com/nodejs/node/pull/26955 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-26doc: edit "How Can I Help?" in Collaborator GuideRich Trott
Edit the "How Can I Help?" section of the Collaborator Guide to keep sentences simple, short, and direct. PR-URL: https://github.com/nodejs/node/pull/26895 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-23doc: edit LTS material in Collaborator GuideRich Trott
* Rewrite some material for simplicity and directness. * Remove outdated LTS material in the Collaborator Guide. (For example, refers to LTS WG for things that are now handled by the Release WG.) * Minor change to text about force pushing (s/minimize/reduce/). PR-URL: https://github.com/nodejs/node/pull/26845 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-19doc: remove How Does LTS Work section from Collaborator GuideRich Trott
The How Does LTS Work section duplicates material in the release plan, to which there is already a link in the doc. Unfortunately, it has gone out of sync with the release plan, resulting in incorrect material being in the Collaborator Guide. (The Release WG needs to approve certain changes, not LTS WG as the guide currently says. It used to be the LTS WG, but that changed.) Instead of duplicating material in the Collaborator Guide and risking that the two documents contradict each other again, instruct the reader to refer to the release plan as the canonical source of information. PR-URL: https://github.com/nodejs/node/pull/26723 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-19doc: condense LTS material in Collaborator GuideRich Trott
Edit and condense the "What is LTS?" section of the Collaboroator Guide. PR-URL: https://github.com/nodejs/node/pull/26722 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-17doc: simplify force-push guidelinesRich Trott
Edit the guildelines for force-pushing in Collaborator Guide. There are no policy changes, but the material is simplified a bit and the sentences are now shorter. PR-URL: https://github.com/nodejs/node/pull/26699 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-15doc: simplify Troubleshooting textRich Trott
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear. PR-URL: https://github.com/nodejs/node/pull/26652 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2019-03-15doc: update copy/paste error message in TroubleshootingRich Trott
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message. PR-URL: https://github.com/nodejs/node/pull/26652 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2019-03-13doc: edit "Technical How-To" section of guideRich Trott
Edit the "Technical How-To" section of the Collaborator Guide. Keep wording simple and direct. PR-URL: https://github.com/nodejs/node/pull/26601 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-03-11doc: edit "Using git-node" section of GuideRich Trott
Edit the "Using git-node" section of the Collaborator Guide. Make sentences concise and clear, reduce use of passive voice, etc. PR-URL: https://github.com/nodejs/node/pull/26580 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Masashi Hirano <shisama07@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-03-10doc: edit Landing Pull RequestsRich Trott
Edit the Landing Pull Requests section of the Collaborators Guide for brevity and clarity. PR-URL: https://github.com/nodejs/node/pull/26536 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Masashi Hirano <shisama07@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-09doc: remove tsc-reviewRich Trott
The tsc-review label is ineffective. It almost always gets ignored. Remove it. When requiring TSC attention, people should @-mention the TSC GitHub team. PR-URL: https://github.com/nodejs/node/pull/26506 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-08doc: edit "Involving the TSC"Rich Trott
Edit the "Involving the TSC" section of the Collaborator Guide to reduce passive voice, make things concise, etc. PR-URL: https://github.com/nodejs/node/pull/26481 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-03-06doc: standardize on End-of-Life capitalizationRich Trott
Use "End-of-Life" everywhere and not "End-of-life" or "End-Of-Life". PR-URL: https://github.com/nodejs/node/pull/26442 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-03-06doc: edit deprecation section of Collaborator GuideRich Trott
Edit the last few paragraphs of the Collaborator Guide section on deprecations. PR-URL: https://github.com/nodejs/node/pull/26419 Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2019-03-03doc: edit deprecation identifier info in Collaborator GuideRich Trott
Edit the deprecation identifier material in the Collaborator Guide for simplicity and clarity. PR-URL: https://github.com/nodejs/node/pull/26372 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-02-27doc: revise deprecation semverness info in Collaborator GuideRich Trott
Simplify and clarify deprecation semverness information in the Collaborator Guide. Unlike some of the other changes I've made lately, this one is not merely cosmetic. It changes information about how to handle deprecations vis-a-vis SemVer. The revised conventions take advange of `notable change` labels etc. instead of suggesting that doc-deprecations be treated as `semver-minor`. The idea that a deprecation is a new feature seems incorrect from a SemVer perspective, but probably made sense at the time the text was written if we weren't yet using `notable change` etc. PR-URL: https://github.com/nodejs/node/pull/26232 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-02-20doc: revise deprecation level explanations in Collaborator GuideRich Trott
Revise deprecation level explanations for scanability and ease of understanding. PR-URL: https://github.com/nodejs/node/pull/26197 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2019-02-18doc: remove deprecation definition in Collaborator GuideRich Trott
The Collaborator Guide links to a definition of "deprecation" but also quotes it extensively. Remove the extensive quotes. PR-URL: https://github.com/nodejs/node/pull/26157 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-02-16doc: consolidate N-API material in Collaborator GuideRich Trott
Consolidate the N-API material in the Collaborator Guide to be succinct and direct. PR-URL: https://github.com/nodejs/node/pull/26094 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Bryan English <bryan@bryanenglish.com>
2019-02-13doc: edit N-API introductory material in Collaborator GuideRich Trott
Use shorter, clearer sentences. Remove passive voice and personal pronouns. PR-URL: https://github.com/nodejs/node/pull/26051 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-02-08doc: revise Introducing New ModulesRich Trott
Revise "Introducing New Modules" in the Collaborator Guide: * Improve clarity. * Remove passive voice. * Keep sentences short for ease of reading/scanning. PR-URL: https://github.com/nodejs/node/pull/25975 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2019-02-06doc: revise Collaborator Guide on revertingRich Trott
Revise the "Reverting commits" section of the Collaborator Guide. Reduce passive voice. Increase clarity. PR-URL: https://github.com/nodejs/node/pull/25942 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2019-02-04doc: improve doc on unintended breaking changesRich Trott
Improve the material in the Collaborator Guide on unintended breaking changes. PR-URL: https://github.com/nodejs/node/pull/25887 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-02-01doc: remove redundant LTS/Current information in Collaborator GuideRich Trott
Remove bullet points about how breaking changes are handled in Current and LTS branches. * This information is covered in https://github.com/nodejs/Release#release-plan. * Having it here and in the above link means that the two may get out of sync, resulting in confusion. * The above link appears later in the doc in the LTS section. * Most Collaborators should not land *anything* in LTS branches and will almost never have a reason to land things into Current branches. They land stuff on the master branch. Adding this material here is confusing because it implies that Collaborators do land stuff on those branches. Save talk about those branches and how they're managed for later in the LTS section where it can be made clear that most Collaborators should not be landing code there anyway. PR-URL: https://github.com/nodejs/node/pull/25842 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-01-30doc: remove outdated COLLABORATOR_GUIDE sentence about breaking changesRich Trott
The TSC has delegated authority over LTS and Current branches to the Release WG. Remove the bullet point about TSC having authority to determine that a breaking change is necessary on LTS and Current release branches. Retaining that authority would require de-chartering the Release WG. Fixes: https://github.com/nodejs/TSC/issues/660 PR-URL: https://github.com/nodejs/node/pull/25780 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2019-01-28doc: revise breaking changes material in COLLABORATOR_GUIDERich Trott
* Remove unnecessary paragraph explaining why Current and LTS have stability guarantees that master branch does not. (Leave material explaining what those stability guarantees are.) * Upgrade advisory and passive "Collaborators should take significant care" to more direct "Take significant care". PR-URL: https://github.com/nodejs/node/pull/25730 Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-12-26doc: revise "Breaking Changes to Internal Elements"Rich Trott
Revise the "Breaking Changes to Internal Elements" section of COLLABORATOR_GUIDE.md. Simplify wording, shorten sentences, and remove redundant material. PR-URL: https://github.com/nodejs/node/pull/25190 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2018-12-21doc: revise "Breaking Changes and Deprecations"Rich Trott
Revise the "Breaking Changes and Deprecations" section of the Collaborator Guide. Simplify the text. Remove redundant text. The "Deprecations" section is thorough and linked to from this section. PR-URL: https://github.com/nodejs/node/pull/25116 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-12-17doc: revise "Breaking Changes" section of Collaborator GuideRich Trott
Simplify material about TSC approval for breaking changes. Omit extraneous material explaining that purely additive changes are not breaking changes. PR-URL: https://github.com/nodejs/node/pull/25071 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: James M Snell <jasnell@gmail.com>
2018-12-13doc: revise internal vs. public API in Collaborator GuideRich Trott
Make the Collaborator Guide section "Internal vs. Public API" more concise and clear. Remove repetition. Clarify some ambiguity. wordy, repetitive, and somewhat PR-URL: https://github.com/nodejs/node/pull/24975 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2018-12-11doc: update Useful CI Jobs section of Collaborator GuideRich Trott
Revise the Useful CI Jobs section of the Collaborator Guide to be more clear and concise. PR-URL: https://github.com/nodejs/node/pull/24916 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-12-09doc: simplify author readyRuben Bridgewater
The label should be applied early on. Otherwise there is little benefit using this label at all. PR-URL: https://github.com/nodejs/node/pull/24893 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-12-08doc: update "Testing and CI" in Collaborator GuideRich Trott
Update "Testing and CI" in the Collaborator Guide. Remove redundant material. Shorten sentences. Remove incorrect material. (Specifically, we don't require test cases to be included in all pull requests that modify exectuable code. For example, if code is refactored, then passing existing tests is sufficient.) PR-URL: https://github.com/nodejs/node/pull/24884 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-12-06doc: revise Waiting for Approvals documentationRich Trott
Revise the Waiting for Approvals section of the Collaborator Guide. Keep sentences short and clear. Split long paragraphs into shorter paragraphs. PR-URL: https://github.com/nodejs/node/pull/24845 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2018-12-04doc: use author's titles for linked resourcesRich Trott
Update Collaborator Guide links to use the title of the item being linked. PR-URL: https://github.com/nodejs/node/pull/24837 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2018-12-04doc: revise code review guidelinesRich Trott
Revise the Code Reviews section of the Collaborator Guide to remove redundant statements, simplify text and structure for easier comprehension, and remove material that does not reflect current practices. PR-URL: https://github.com/nodejs/node/pull/24790 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2018-12-03doc: streamline Accepting Modifications in Collaborator GuideRich Trott
Editing a sentence I missed simplifying in the last pass on that section. PR-URL: https://github.com/nodejs/node/pull/24807 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-11-27doc: revise accepting-modifications in guideRich Trott
Revise the "Accepting Modifications" section of the Collaborator Guide. PR-URL: https://github.com/nodejs/node/pull/24650 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2018-11-25doc: revise handling-own-pull-requests textRich Trott
Simplify and clarify the text of the COLLABORATORS_GUIDE where handling one's own pull requests is concerned. PR-URL: https://github.com/nodejs/node/pull/24583 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-27 13:38:57 +0000