|
2 | 2 |
|
3 | 3 | 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:. |
4 | 4 |
|
| 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 | + |
5 | 7 | Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. |
6 | 8 |
|
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). |
8 | 10 |
|
9 | 11 | 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. |
10 | 12 |
|
11 | 13 | ## New contributor guide |
12 | 14 |
|
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: |
14 | 18 |
|
15 | 19 | - [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) |
16 | 20 | - [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) |
17 | 21 | - [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) |
18 | 22 | - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
19 | 23 |
|
20 | | - |
21 | 24 | ## Getting started |
22 | 25 |
|
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)." |
| 26 | +📚 **Primary resource:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing) contains our complete contribution workflow and policies. |
24 | 27 |
|
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:. |
| 28 | +For repository-specific information: |
| 29 | +- See [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball: |
| 30 | +- Check our [types of contributions](/contributing/types-of-contributions.md) we accept |
| 31 | +- Review our markdown style guidelines in the `/contributing` directory |
26 | 32 |
|
27 | 33 | ### Issues |
28 | 34 |
|
29 | | -#### Create a new issue |
30 | | - |
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). |
32 | | - |
33 | | -#### Solve an issue |
| 35 | +**For detailed issue guidelines, see [docs.github.com/en/contributing](https://docs.github.com/en/contributing).** |
34 | 36 |
|
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. |
| 37 | +#### Repository-specific notes: |
| 38 | +- Search [existing issues](https://github.com/github/docs/issues) before creating new ones |
| 39 | +- Use our [label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) to categorize appropriately |
| 40 | +- Follow the issue templates provided in this repository |
36 | 41 |
|
37 | 42 | ### Make Changes |
38 | 43 |
|
39 | | -#### Make changes in the UI |
| 44 | +**Complete change guidelines are available at [docs.github.com/en/contributing](https://docs.github.com/en/contributing).** |
40 | 45 |
|
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. |
| 46 | +#### Repository-specific options: |
42 | 47 |
|
43 | | - <img src="/contributing/images/contribution_cta.png" /> |
| 48 | +**Make changes in the UI:** Click **Make a contribution** at the bottom of any docs page for small changes like typos or broken links. |
44 | 49 |
|
45 | | -#### Make changes in a codespace |
| 50 | +<img src="/contributing/images/contribution_cta.png" /> |
46 | 51 |
|
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)." |
| 52 | +**Make changes in a codespace:** See "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)" for documentation-specific setup. |
48 | 53 |
|
49 | | -#### Make changes locally |
| 54 | +**Make changes locally:** |
| 55 | +1. Fork the repository (see [official forking guide](https://docs.github.com/en/contributing)) |
| 56 | +2. Install Node.js at the version specified in `.node-version` (see [development guide](../contributing/development.md)) |
| 57 | +3. Create a working branch and start with your changes |
50 | 58 |
|
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)! |
55 | | - |
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. |
| 59 | +### Commit your update |
58 | 60 |
|
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). |
| 61 | +Follow the guidelines at [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for commit best practices. |
60 | 62 |
|
61 | | -3. Create a working branch and start with your changes! |
| 63 | +Use our "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" before committing. |
62 | 64 |
|
63 | | -### Commit your update |
| 65 | +### Pull Request |
64 | 66 |
|
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:. |
| 67 | +**Complete PR guidelines:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing) |
66 | 68 |
|
67 | | -### Pull Request |
| 69 | +**Repository-specific notes:** |
| 70 | +- Fill the "Ready for review" template |
| 71 | +- [Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable |
| 72 | +- 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) |
68 | 73 |
|
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. |
| 74 | +A Docs team member will review following our [standard review process](https://docs.github.com/en/contributing). |
77 | 75 |
|
78 | 76 | ### Your PR is merged! |
79 | 77 |
|
80 | 78 | Congratulations :tada::tada: The GitHub team thanks you :sparkles:. |
81 | 79 |
|
82 | | -Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en). |
| 80 | +Once merged, your contributions will be visible on [GitHub docs](https://docs.github.com/en). |
83 | 81 |
|
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). |
| 82 | +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). |
85 | 83 |
|
86 | 84 | ## Windows |
87 | 85 |
|
|
0 commit comments