summaryrefslogtreecommitdiff
path: root/doc/guides/contributing
diff options
context:
space:
mode:
authorNick Schonning <nschonni@gmail.com>2019-09-13 00:22:29 -0400
committerRich Trott <rtrott@gmail.com>2019-09-16 11:24:54 -0700
commite2dcbf1c3231513c38151d729f180a54ea902da9 (patch)
tree1f9197fb7c0af601c310a179ba089fdac8d6d5b5 /doc/guides/contributing
parent3d841fe20d732111094c3f62febd5a6b8b483b91 (diff)
downloadandroid-node-v8-e2dcbf1c3231513c38151d729f180a54ea902da9.tar.gz
android-node-v8-e2dcbf1c3231513c38151d729f180a54ea902da9.tar.bz2
android-node-v8-e2dcbf1c3231513c38151d729f180a54ea902da9.zip
doc: use consistent unordered list style
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>
Diffstat (limited to 'doc/guides/contributing')
-rw-r--r--doc/guides/contributing/pull-requests.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md
index ec6beb0bb5..a9ac6e4254 100644
--- a/doc/guides/contributing/pull-requests.md
+++ b/doc/guides/contributing/pull-requests.md
@@ -106,10 +106,10 @@ $ git checkout -b my-branch -t upstream/master
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 `doc/api`
-- tests within the `test` directory.
+* the C/C++ code contained in the `src` directory
+* the JavaScript code contained in the `lib` directory
+* 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
time to ensure that the changes follow the Node.js code style guide.
@@ -143,17 +143,17 @@ notes about [commit squashing](#commit-squashing).
A good commit message should describe what changed and why.
1. The first line should:
- - contain a short description of the change (preferably 50 characters or
+ * contain a short description of the change (preferably 50 characters or
less, and no more than 72 characters)
- - be entirely in lowercase with the exception of proper nouns, acronyms, and
+ * be entirely in lowercase with the exception of proper nouns, acronyms, and
the words that refer to code, like function/variable names
- - be prefixed with the name of the changed subsystem and start with an
+ * be prefixed with the name of the changed subsystem and start with an
imperative verb. Check the output of `git log --oneline files/you/changed` to
find out what subsystems your changes touch.
Examples:
- - `net: add localAddress and localPort to Socket`
- - `src: fix typos in async_wrap.h`
+ * `net: add localAddress and localPort to Socket`
+ * `src: fix typos in async_wrap.h`
2. Keep the second line blank.
3. Wrap all other lines at 72 columns (except for long URLs).
@@ -163,9 +163,9 @@ A good commit message should describe what changed and why.
references use `Refs:`.
Examples:
- - `Fixes: https://github.com/nodejs/node/issues/1337`
- - `Refs: https://eslint.org/docs/rules/space-in-parens.html`
- - `Refs: https://github.com/nodejs/node/pull/3615`
+ * `Fixes: https://github.com/nodejs/node/issues/1337`
+ * `Refs: https://eslint.org/docs/rules/space-in-parens.html`
+ * `Refs: https://github.com/nodejs/node/pull/3615`
5. If your commit introduces a breaking change (`semver-major`), it should
contain an explanation about the reason of the breaking change, which