docs/CONTRIBUTING.md

Welcome to GitHub docs contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on docs.github.com ✨.

Read our Code of Coduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use table of contents icon on the top left corner of the this document to get to a specific section of this guide quickly.

New contributor guide

See README.md to get an overview of the project. Here are some helpful resources to get you comfortable with open source contribution.

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

See working in docs repository to navigate our codebase with confidence 🎊. See GitHub Markdown for information on how we write our markdown files.

Before making changes, see what types contributions we accept. Some of them don't require writing even a single line of code ✨.

Issues

Solve an issue

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.

Create a new issue

If you spot an issue with the docs and if a related issue doesn't exist, you can open a new issue using a relavent issue form.

Make Changes

Make changes in the UI

You can make simple changes such as a typo, sentence fix, broken link in the UI. Use Make a contribution at the bottom of any docs page to navigate directly to the .md file. Make your changes and create a PR for a review.

Make changes locally

Install Git LFS.

Forking repository

• GitHub 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!

• Command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

• GitHub Codespaces:

  • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.

Install/Update your to Node.js v16. For more information, see "contributing/development.md."

Create a working branch and start with your changes!

Commit your update:

Commit the changes once you are happy with them. Here are some commonly used short and fun commit messages.

• ✏️ :pencil2: fix typos
• 📝 :memo: add or update documentation
• ⛓️ :chains: for fixing links
• 🐛 :bug: for bug fix (Cant think of more, any ideas?)

Once you are ready with your changes, don't forget to self review, to quicken the review process ⚡.

Pull Request

• When you're done making the changes, open a PR (pull request).
• Fill out the "Ready for review" template so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.
• 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.
• Once you submit your PR, one of the writers would review your proposal. Keep an eye for any 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.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations :tada:🎉 The whole GitHub community thanks you ✨.

Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.

Now that you are part of the GitHub docs community, see how else you can contribute to the docs.

Windows

This site can be developed on Windows, however a few potential gotchas need to be kept in mind:

1. Regular Expressions: Windows uses \r\n for line endings, while Unix based systems use \n. Therefore when working on Regular Expressions, use \r?\n instead of \n in order to support both environments. The Node.js os.EOL property can be used to get an OS-specific end-of-line marker.
2. Paths: Windows systems use \ for the path separator, which would be returned by path.join and others. You could use path.posix, path.posix.join etc and the slash module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write scripts in JavaScript instead of Bash.
4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with msys. While the suggestions below are not guaranteed to work and could possibly cause other issues, a few workarounds include:
   • Shorten the path by cloning this repo directly into C:\
   • Use a different Git client on Windows
   • Update Git configuration: git config --system core.longpaths true