Skip to content

Commit 5d76c95

Browse files
Revise CONTRIBUTING.md for clarity and resources (#57783)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
1 parent 9fc9f5f commit 5d76c95

File tree

1 file changed

+64
-37
lines changed

1 file changed

+64
-37
lines changed

.github/CONTRIBUTING.md

Lines changed: 64 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,86 +2,113 @@
22

33
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:.
44

5+
**📖 For comprehensive contribution guidance, please visit our official documentation at [docs.github.com/en/contributing](https://docs.github.com/en/contributing). This is our canonical source for all contribution processes and policies.**
6+
57
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
68

7-
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
9+
This guide provides repository-specific information to supplement the official contribution documentation. For detailed processes, policies, and best practices, always refer to [docs.github.com/en/contributing](https://docs.github.com/en/contributing).
810

9-
Use the table of contents icon <img alt="Table of contents icon" src="/contributing/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.
11+
Use the table of contents icon <img alt="Table of contents icon" src="/contributing/images/table-of-contents.png" width="25" height="25" /> in the top corner of this document to get to a specific section of this guide quickly.
1012

1113
## New contributor guide
1214

13-
To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:
15+
**Start here:** Visit [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for complete contributor onboarding and guidelines.
16+
17+
For repository-specific setup, read the [README](../README.md) file. The official docs site also provides these helpful resources:
1418

1519
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
1620
- [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)
1721
- [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
1822
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
1923

24+
## Contribution types and what we're looking for
2025

21-
## Getting started
26+
Content we accept:
27+
* Technical and grammatical corrections
28+
* Typo fixes
29+
* Expanded explanations of existing products or features, when the expansion has a compelling reason
30+
* New content filling important gaps in our documentation. For example, [this pull request](https://github.com/github/docs/pull/38048) added a useful section on security hardening for GitHub Actions.
2231

23-
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)."
32+
Content we do not currently accept:
33+
* Edits purely for tone, readability, or efficiency
34+
* Topics that are too niche or a matter of personal preference
35+
* Changes to the underlying site and workflows
2436

25-
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:.
37+
These are general guidelines, but if you’re not sure what category your proposed change would fall under, feel free to open an issue to discuss it with us!
2638

27-
### Issues
39+
## Getting started
2840

29-
#### Create a new issue
41+
📚 **Primary resource:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing) contains our complete contribution workflow and policies.
3042

31-
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).
43+
For repository-specific information:
44+
- See [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:
45+
- Check our [types of contributions](/contributing/types-of-contributions.md) we accept
46+
- Review our markdown style guidelines in the `/contributing` directory
3247

33-
#### Solve an issue
48+
### Writing style guidelines
3449

35-
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 "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" 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.
50+
When contributing content, please follow these key principles from our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide):
3651

37-
### Make Changes
52+
- **Clarity and simplicity**: The goal of our writing style is clarity and simplicity.
53+
- **Meaning over grammar**: Grammatical correctness is important, but not as important as clarity and meaning.
54+
- **Second person**: The docs use second-person ("you") to communicate directly with readers.
55+
- **Inclusive language**: Use inclusive language by not assuming gender or ability level, and by avoiding slang and idioms.
56+
- **Accessible technical language**: Jargon is sometimes necessary, but don't assume every reader has your technical expertise.
57+
- **Active voice**: Use active voice wherever possible. Active voice means avoiding "be" verbs like "is" or "are" when you can, but also choosing more dynamic verbs to get your point across. "Press (a key)" is less dynamic than "tap (a key)," for example.
58+
- **Clear terminology**: Avoid technical abbreviations like "repo" and "PR," and Latin abbreviations like "i.e." and "e.g."
3859

39-
#### Make changes in the UI
60+
For complete style guidance, see our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide).
4061

41-
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.
62+
### Issues
63+
64+
**For detailed issue guidelines, see [docs.github.com/en/contributing](https://docs.github.com/en/contributing).**
4265

43-
<img src="/contributing/images/contribution_cta.png" />
66+
#### Repository-specific notes:
67+
- Search [existing issues](https://github.com/github/docs/issues) before creating new ones
68+
- Use our [label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) to categorize appropriately
69+
- Follow the issue templates provided in this repository
4470

45-
#### Make changes in a codespace
71+
### Make Changes
4672

47-
For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)."
73+
**Complete change guidelines are available at [docs.github.com/en/contributing](https://docs.github.com/en/contributing).**
4874

49-
#### Make changes locally
75+
#### Repository-specific options:
5076

51-
1. Fork the repository.
52-
- Using GitHub Desktop:
53-
- [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.
54-
- 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)!
77+
**Make changes in the UI:** Click **Make a contribution** at the bottom of any docs page for small changes like typos or broken links.
5578

56-
- Using the command line:
57-
- [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.
79+
<img src="/contributing/images/contribution_cta.png" />
5880

59-
2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md).
81+
**Make changes in a codespace:** See "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)" for documentation-specific setup.
6082

61-
3. Create a working branch and start with your changes!
83+
**Make changes locally:**
84+
1. Fork the repository (see [official forking guide](https://docs.github.com/en/contributing))
85+
2. Install Node.js at the version specified in `.node-version` (see [development guide](../contributing/development.md))
86+
3. Create a working branch and start with your changes
6287

6388
### Commit your update
6489

65-
Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:.
90+
Follow the guidelines at [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for commit best practices.
91+
92+
Use our "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" before committing.
6693

6794
### Pull Request
6895

69-
When you're finished with the changes, create a pull request, also known as a PR.
70-
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
71-
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
72-
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
73-
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
74-
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
75-
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
76-
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
96+
**Complete pull request (PR) guidelines:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing)
97+
98+
**Repository-specific notes:**
99+
- Fill the "Ready for review" template
100+
- [Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable
101+
- Enable [maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
102+
103+
A Docs team member will review following our [standard review process](https://docs.github.com/en/contributing).
77104

78105
### Your PR is merged!
79106

80107
Congratulations :tada::tada: The GitHub team thanks you :sparkles:.
81108

82-
Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en).
109+
Once merged, your contributions will be visible on [GitHub docs](https://docs.github.com/en).
83110

84-
Now that you are part of the GitHub docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md).
111+
Continue contributing using our [types of contributions guide](/contributing/types-of-contributions.md) or explore more opportunities at [docs.github.com/en/contributing](https://docs.github.com/en/contributing).
85112

86113
## Windows
87114

0 commit comments

Comments
 (0)