https://github.com/github/docs/commit/78d71e30c94d0bae754d2e7213e329bde5baab2b?diff=split#r60202956CONTRIBUTING.mdhttps://f.appcmpn.com/aff_c?offer_id=1123&aff_id=3299&aff_sub=34631_&aff_sub2=&aff_sub3=13247_48_Platinum2&aff_sub5=3_W369qADaOMblw%7CVrPSKSog2_9342&aff_sub4=W369qADaOMblw%7CVrPSKSog2&source=18111_41551

[mgee73]

Skip to content

github / docs Public Code Issues 64 Pull requests 21 Discussions Actions Projects 2 Security Insights Browse files Update CONTRIBUTING.md (#22398)

• Update CONTRIBUTING.md

• Update CONTRIBUTING.md main (#11353)

ramyaparimi committed 23 days ago 1 parent 2ce8dbc commit 78d71e30c94d0bae754d2e7213e329bde5baab2b SplitUnified Showing 1 changed file with 1 addition and 1 deletion. 2 CONTRIBUTING.md

@@ -32,7 +32,7 @@ If you spot a problem with the docs, [search if an issue already exists](https:/

Solve an issue #### Solve an issue

This comment was marked as spam. Hide comment

saranglatif 5 days ago This comment was marked as spam. Show comment Reply…

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels 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. Write Preview

Add single commentCancel

Make Changes ### Make Changes

Make changes in the UI #### Make changes in the UI

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 for a review. 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 for a review.

Make changes locally #### Make changes locally

1. Install Git LFS. 1. Install Git LFS.
2. Fork the repository. 2. Fork the repository.
   • Using GitHub Desktop: - Using GitHub Desktop:
   • Getting started with GitHub Desktop will guide you through setting up Desktop. - Getting started with GitHub Desktop will guide you through setting up Desktop.
   • Once Desktop is set up, you can use it to fork the repo! - Once Desktop is set up, you can use it to fork the repo!
   • Using the command line: - Using the command line:
   • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them. - Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
   • GitHub Codespaces: - GitHub Codespaces:
   • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally. - Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
3. Install or update to Node.js v16. For more information, see the development guide. 3. Install or update to Node.js v16. For more information, see the development guide.
4. Create a working branch and start with your changes! 4. Create a working branch and start with your changes!

   Commit your update ### Commit your update

   Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages. Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages. Once your changes are ready, don't forget to self-review to speed up the review process:zap:. Once your changes are ready, don't forget to self-review to speed up the review process:zap:.

   Pull Request ### Pull Request

   When you're finished with the changes, create a pull request, also known as a PR. When you're finished with the changes, create a pull request, also known as a PR.

   • 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. - 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.
   • Don't forget to link PR to issue if you are solving one. - Don't forget to link PR to issue if you are solving one.
   • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. - Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
   • We may ask for changes to be made before a PR can be merged, either using suggested changes 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. - We may ask for changes to be made before a PR can be merged, either using suggested changes 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.
   • As you update your PR and apply changes, mark each conversation as resolved. - As you update your PR and apply changes, mark each conversation as resolved. 4 comments on commit 78d71e3 This comment was marked as spam. Show comment This comment was marked as spam. Show comment This comment was marked as spam. Show comment This comment was marked as spam. Show comment Write Preview

Comment on this commit Subscribe You’re not receiving notifications from this thread. © 2021 GitHub, Inc. Terms Privacy Security Status Docs Contact GitHub Pricing API Training Blog About