From 9821ce8960887d5e86291494c2066aa218ef2a05 Mon Sep 17 00:00:00 2001 From: FrankQiu Date: Thu, 3 Dec 2020 10:53:55 +0800 Subject: [PATCH] doc: Revise Github to GitHub --- deps/node-inspect/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/deps/node-inspect/CONTRIBUTING.md b/deps/node-inspect/CONTRIBUTING.md index 012d29471462de..d10a0545c7cb90 100644 --- a/deps/node-inspect/CONTRIBUTING.md +++ b/deps/node-inspect/CONTRIBUTING.md @@ -48,7 +48,7 @@ By making a contribution to this project, I certify that: ### Reporting Issues If you find any mistakes in the docs or a bug in the code, -please [open an issue in Github](https://github.com/nodejs/node-inspect/issues/new) so we can look into it. +please [open an issue in GitHub](https://github.com/nodejs/node-inspect/issues/new) so we can look into it. You can also [create a PR](#contributing-code) fixing it yourself of course. If you report a bug, please follow these guidelines: @@ -63,9 +63,9 @@ If you report a bug, please follow these guidelines: ### Improving Documentation -For small documentation changes, you can use [Github's editing feature](https://help.github.com/articles/editing-files-in-another-user-s-repository/). +For small documentation changes, you can use [GitHub's editing feature](https://help.github.com/articles/editing-files-in-another-user-s-repository/). The only thing to keep in mind is to prefix the commit message with "docs: ". -The default commit message generated by Github will lead to a failing CI build. +The default commit message generated by GitHub will lead to a failing CI build. For larger updates to the documentation it might be better to follow the [instructions for contributing code below](#contributing-code). @@ -92,7 +92,7 @@ The general steps for creating a pull request are: This is expected until you commit your changes. 1. Once you're done, `git add .` and `git commit`. Please follow the [commit message conventions](#commits--commit-messages) described below. -1. Push your branch to Github & create a PR. +1. Push your branch to GitHub & create a PR. #### Code Style