From 9a84d79b1c42e730bb27ae0bea15fcfdd180944d Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Tue, 3 Apr 2018 11:04:30 -0700 Subject: [PATCH 1/2] doc: create list for commonly edited files in PRs --- doc/guides/contributing/pull-requests.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 9220ab4e8e6396..c9f4acf87902fb 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -101,9 +101,11 @@ $ git checkout -b my-branch -t upstream/master ### Step 3: Code The vast majority of Pull Requests opened against the `nodejs/node` -repository includes changes to either the C/C++ code contained in the `src` -directory, the JavaScript code contained in the `lib` directory, the -documentation in `docs/api` or tests within the `test` directory. +repository includes changes to one or more of the following: + - the C/C++ code contained in the `src` directory + - the JavaScript code contained in the `lib` directory + - the documentation in `docs/api` + - tests within the `test` directory. If you are modifying code, please be sure to run `make lint` from time to time to ensure that the changes follow the Node.js code style guide. From fafc5afe1848797c6b1ea4c66e7c1bc1acb1adcf Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Tue, 3 Apr 2018 15:51:12 -0700 Subject: [PATCH 2/2] fixup: addressing comments from @addaleax --- doc/guides/contributing/pull-requests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index c9f4acf87902fb..44ae689bf9c7c9 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -104,7 +104,7 @@ The vast majority of Pull Requests opened against the `nodejs/node` repository includes changes to one or more of the following: - the C/C++ code contained in the `src` directory - the JavaScript code contained in the `lib` directory - - the documentation in `docs/api` + - the documentation in `doc/api` - tests within the `test` directory. If you are modifying code, please be sure to run `make lint` from time to