You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+21-13Lines changed: 21 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,13 @@
4
4
5
5
# Welcome to GitHub docs contributing guide <!-- omit in toc -->
6
6
7
-
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en):sparkles:.
7
+
Thank you for investing your time in contributing to this project!
8
8
9
+
Before you get started, please review the following guidelines:
9
10
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
10
11
11
12
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
12
13
13
-
Use the table of contents icon <imgsrc="./assets/images/table-of-contents.png"width="25"height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
14
-
15
14
## New contributor guide
16
15
17
16
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
@@ -21,28 +20,33 @@ To get an overview of the project, read the [README](README.md). Here are some r
-[Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
23
22
24
-
25
23
## Getting started
26
24
27
-
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md):confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
25
+
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md):confetti_ball:.
26
+
For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
28
27
29
-
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
28
+
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes.
29
+
Some of them don't even require writing a single line of code :sparkles:.
30
30
31
31
### Issues
32
32
33
33
#### Create a new issue
34
34
35
-
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
35
+
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
36
+
If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
36
37
37
38
#### Solve an issue
38
39
39
-
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
40
+
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you.
41
+
You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information.
42
+
As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
40
43
41
44
### Make Changes
42
45
43
46
#### Make changes in the UI
44
47
45
-
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
48
+
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link.
49
+
This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
@@ -52,22 +56,26 @@ Click **Make a contribution** at the bottom of any docs page to make small chang
52
56
53
57
2. Fork the repository.
54
58
- Using GitHub Desktop:
55
-
-[Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
59
+
-[Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop)
60
+
will guide you through setting up Desktop.
56
61
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
57
62
58
63
- Using the command line:
59
-
-[Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
64
+
-[Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make
65
+
your changes without affecting the original project until you're ready to merge them.
60
66
61
67
- GitHub Codespaces:
62
-
-[Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
68
+
-[Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace)
69
+
using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
63
70
64
71
3. Install or update to **Node.js v16**. For more information, see [the development guide](contributing/development.md).
65
72
66
73
4. Create a working branch and start with your changes!
67
74
68
75
### Commit your update
69
76
70
-
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages.
77
+
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages)
78
+
to know how to use emoji for commit messages.
71
79
72
80
Once your changes are ready, don't forget to [self-review](/contributing/self-review.md) to speed up the review process:zap:.
0 commit comments