xiweicheng/docs

This is the open-source repo for docs.github.com.

GitHub Docs

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

In this article:

• Contributing
• READMEs
• License
• Contributors ✨

Contributing

Start contributing right now:

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click make a contribution from docs

As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Join us in discussions

We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

And that's it!

That's how you can get started easily as a member of the GitHub Documentation community. ✨

If you want to know more, or you're making a more complex contribution, check out Getting Started with Contributing.

There are a few more things to know when you're getting started with this repo:

1. If you're having trouble with your GitHub account, contact Support.
2. We do not accept pull requests for translated content - see CONTRIBUTING.md for more information.

READMEs

In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:

• content/README.md
• contributing/README.md
• data/README.md
• data/reusables/README.md
• data/variables/README.md
• includes/liquid-tags/README.md
• includes/README.md
• javascripts/README.md
• layouts/README.md
• lib/liquid-tags/README.md
• middleware/README.md
• script/README.md
• stylesheets/README.md
• tests/README.md

License

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under a MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alexandra Bourne 🖋 🐛	Cynthia Rich 🖋 🐛	Emily Gould 🖋 🐛	Felicity Chapman 🖋 🐛	Kevin Heis 🐛 💻	Alistair Christie 🖋 🐛	James M. Greene 🐛 💻
Janice 🖋 🐛	Jason Etcovitch 🐛 💻	James Fletcher 🖋 🐛	Jenn Leaver 🖋 🐛	jmarlena 🖋 🐛	John M. Wargo 🖋 🐛	Laura Coursen 🖋 🐛
Lucas Costi 🖋 🐛	Martin Lopes 🖋 🐛	Matt Pollard 🖋 🐛	mc 🖋 🐛	Meg Bird 🖋 🐛	Melanie Yarbrough 🖋 🐛	Rachael Sewell 🖋 🐛
Leona B. Campbell 🖋 🐛	Sarah Schneider 🐛 💻	Shati Patel 🖋 🐛	Kathy Korevec 🖋 🐛	Amy Burns 🖋 🐛	Vanessa Yuen 🐛 💻	Zeke Sikelianos 🐛 💻
Benjamin Nickolls 📖

This project follows the all-contributors specification. Contributions of any kind welcome!