2020-09-27 15:10:11 +03:00
## GitHub Docs <!-- omit in toc -->
2013-01-08 15:55:39 +04:00
2020-09-27 15:10:11 +03:00
This repository contains the documentation website code and Markdown source files for docs.github.com.
2020-10-06 00:44:29 +03:00
GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
2020-09-27 15:10:11 +03:00
In this article:
- [Contributing ](#contributing )
- [READMEs ](#readmes )
- [License ](#license )
- [Contributors ✨ ](#contributors- )
## Contributing
2020-10-06 00:44:29 +03:00
### Start contributing today:
2020-09-27 15:10:11 +03:00
2020-10-06 02:26:19 +03:00
We accept a lot of [different contributions ](CONTRIBUTING.md/#types-of-contributions-memo ), and some that don't require you to write a single line of code.
2020-09-27 15:10:11 +03:00
2020-10-06 07:51:57 +03:00
#### Click **make a contribution** from docs
2020-10-06 02:21:26 +03:00
As you're using GitHub Documentation, you may find something in an article that you'd like to add to, update or change. Clicking on the 'make a contribution' button will navigate you directly to that article in the codebase so that you can begin making your contribution.
2020-10-06 03:07:52 +03:00
< img src = "./assets/images/contribution_cta.png" width = "400" >
2020-10-06 01:31:14 +03:00
2020-10-06 00:44:29 +03:00
**Open an issue**
2020-10-06 01:31:14 +03:00
2020-10-06 00:44:29 +03:00
If you've found a problem, you can open an issue using a [template ](https://github.com/github/docs/issues/new/choose ).
2020-09-27 15:10:11 +03:00
2020-10-06 00:44:29 +03:00
**Join us in discussions**
2020-10-06 01:31:14 +03:00
2020-10-06 00:44:29 +03:00
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 ](https://github.com/github/docs/discussions ).
2020-09-27 15:10:11 +03:00
2020-10-06 01:31:14 +03:00
**And that's it!**
That's how you can get started easily as a member of the GitHub Documentation community. :sparkles:
If you want to know more, or you're making a more complex contribution, check out the Getting Started with Contributing guide in [CONTRIBUTING ](/CONTRIBUTING.md ).
2020-10-06 00:44:29 +03:00
2020-10-06 03:34:45 +03:00
There are a few more things to know when you're getting started with this repo:
2020-10-06 00:44:29 +03:00
1. If you're having trouble with your GitHub account, contact [Support ](https://support.github.com/contact ).
2. We do not accept pull requests for translated content - see [CONTRIBUTING.md ](/CONTRIBUTING.md ) for more information.
2020-09-27 15:10:11 +03:00
## 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 ](content/README.md )
2020-10-01 21:27:27 +03:00
- [contributing/README.md ](contributing/README.md )
2020-09-27 15:10:11 +03:00
- [data/README.md ](data/README.md )
- [data/reusables/README.md ](data/reusables/README.md )
- [data/variables/README.md ](data/variables/README.md )
- [includes/liquid-tags/README.md ](includes/liquid-tags/README.md )
- [includes/README.md ](includes/README.md )
- [javascripts/README.md ](javascripts/README.md )
- [layouts/README.md ](layouts/README.md )
- [lib/liquid-tags/README.md ](lib/liquid-tags/README.md )
- [middleware/README.md ](middleware/README.md )
- [script/README.md ](script/README.md )
- [stylesheets/README.md ](stylesheets/README.md )
- [tests/README.md ](tests/README.md )
## License
The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license ](content/LICENSE ).
All other code in this repository is licensed under a [MIT ](LICENSE.md ).
When using the GitHub logos, be sure to follow the [GitHub logo guidelines ](https://github.com/logos ).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
< td align = "center" > < a href = "https://github.com/alebourne" > < img src = "https://avatars1.githubusercontent.com/u/24581915?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Alexandra Bourne< / b > < / sub > < / a > < br / > < a href = "#content-alebourne" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Aalebourne" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "http://cynthiarich.me/" > < img src = "https://avatars0.githubusercontent.com/u/9950121?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Cynthia Rich< / b > < / sub > < / a > < br / > < a href = "#content-crichID" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3AcrichID" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/emilyistoofunky" > < img src = "https://avatars1.githubusercontent.com/u/4822039?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Emily Gould< / b > < / sub > < / a > < br / > < a href = "#content-emilyistoofunky" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Aemilyistoofunky" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/felicitymay" > < img src = "https://avatars1.githubusercontent.com/u/1877141?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Felicity Chapman< / b > < / sub > < / a > < br / > < a href = "#content-felicitymay" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Afelicitymay" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://heiskr.com/" > < img src = "https://avatars2.githubusercontent.com/u/1221423?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Kevin Heis< / b > < / sub > < / a > < br / > < a href = "https://github.com/github/docs/issues?q=author%3Aheiskr" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/github/docs/commits?author=heiskr" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/hubwriter" > < img src = "https://avatars1.githubusercontent.com/u/54933897?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Alistair Christie< / b > < / sub > < / a > < br / > < a href = "#content-hubwriter" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ahubwriter" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://jamesmgreene.github.io/" > < img src = "https://avatars2.githubusercontent.com/u/417751?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > James M. Greene< / b > < / sub > < / a > < br / > < a href = "https://github.com/github/docs/issues?q=author%3AJamesMGreene" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/github/docs/commits?author=JamesMGreene" title = "Code" > 💻< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://github.com/janiceilene" > < img src = "https://avatars3.githubusercontent.com/u/9817819?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Janice< / b > < / sub > < / a > < br / > < a href = "#content-janiceilene" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ajaniceilene" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://jasonet.co" > < img src = "https://avatars1.githubusercontent.com/u/10660468?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Jason Etcovitch< / b > < / sub > < / a > < br / > < a href = "https://github.com/github/docs/issues?q=author%3Ajasonetco" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/github/docs/commits?author=jasonetco" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/jf205" > < img src = "https://avatars2.githubusercontent.com/u/42464962?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > James Fletcher< / b > < / sub > < / a > < br / > < a href = "#content-jf205" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ajf205" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/jleaver" > < img src = "https://avatars2.githubusercontent.com/u/4453117?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Jenn Leaver< / b > < / sub > < / a > < br / > < a href = "#content-jleaver" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ajleaver" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/jmarlena" > < img src = "https://avatars3.githubusercontent.com/u/6732600?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > jmarlena< / b > < / sub > < / a > < br / > < a href = "#content-jmarlena" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ajmarlena" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://johnwargo.com/" > < img src = "https://avatars0.githubusercontent.com/u/30843404?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > John M. Wargo< / b > < / sub > < / a > < br / > < a href = "#content-jwargo" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ajwargo" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/lecoursen" > < img src = "https://avatars3.githubusercontent.com/u/14935376?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Laura Coursen< / b > < / sub > < / a > < br / > < a href = "#content-lecoursen" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Alecoursen" title = "Bug reports" > 🐛< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://lucascosti.com/" > < img src = "https://avatars3.githubusercontent.com/u/4434330?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Lucas Costi< / b > < / sub > < / a > < br / > < a href = "#content-lucascosti" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Alucascosti" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/martin389" > < img src = "https://avatars3.githubusercontent.com/u/54248166?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Martin Lopes< / b > < / sub > < / a > < br / > < a href = "#content-martin389" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Amartin389" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/mattpollard" > < img src = "https://avatars0.githubusercontent.com/u/1894408?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Matt Pollard< / b > < / sub > < / a > < br / > < a href = "#content-mattpollard" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Amattpollard" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/mchammer01" > < img src = "https://avatars3.githubusercontent.com/u/42146119?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > mc< / b > < / sub > < / a > < br / > < a href = "#content-mchammer01" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Amchammer01" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "http://meaganbird.com/" > < img src = "https://avatars2.githubusercontent.com/u/5658046?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Meg Bird< / b > < / sub > < / a > < br / > < a href = "#content-megbird" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Amegbird" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/myarb" > < img src = "https://avatars2.githubusercontent.com/u/11952755?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Melanie Yarbrough< / b > < / sub > < / a > < br / > < a href = "#content-myarb" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Amyarb" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/rachmari" > < img src = "https://avatars2.githubusercontent.com/u/9831992?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Rachael Sewell< / b > < / sub > < / a > < br / > < a href = "#content-rachmari" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Arachmari" title = "Bug reports" > 🐛< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://github.com/runleonarun" > < img src = "https://avatars1.githubusercontent.com/u/3880403?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Leona B. Campbell< / b > < / sub > < / a > < br / > < a href = "#content-runleonarun" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Arunleonarun" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/sarahs" > < img src = "https://avatars3.githubusercontent.com/u/821071?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Sarah Schneider< / b > < / sub > < / a > < br / > < a href = "https://github.com/github/docs/issues?q=author%3Asarahs" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/github/docs/commits?author=sarahs" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/shati-patel" > < img src = "https://avatars3.githubusercontent.com/u/42641846?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Shati Patel< / b > < / sub > < / a > < br / > < a href = "#content-shati-patel" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Ashati-patel" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "http://kathy.pm/" > < img src = "https://avatars3.githubusercontent.com/u/704152?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Kathy Korevec< / b > < / sub > < / a > < br / > < a href = "#content-simpsoka" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Asimpsoka" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/timeyoutakeit" > < img src = "https://avatars3.githubusercontent.com/u/5012825?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Amy Burns< / b > < / sub > < / a > < br / > < a href = "#content-timeyoutakeit" title = "Content" > 🖋< / a > < a href = "https://github.com/github/docs/issues?q=author%3Atimeyoutakeit" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" > < a href = "https://github.com/vanessayuenn" > < img src = "https://avatars3.githubusercontent.com/u/6842965?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Vanessa Yuen< / b > < / sub > < / a > < br / > < a href = "https://github.com/github/docs/issues?q=author%3Avanessayuenn" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/github/docs/commits?author=vanessayuenn" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "http://zeke.sikelianos.com/" > < img src = "https://avatars1.githubusercontent.com/u/2289?v=4?s=64" width = "64px;" alt = "" / > < br / > < sub > < b > Zeke Sikelianos< / b > < / sub > < / a > < br / > < a href = "https://github.com/github/docs/issues?q=author%3Azeke" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/github/docs/commits?author=zeke" title = "Code" > 💻< / a > < / td >
< / tr >
< / table >
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2020-10-06 00:44:29 +03:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
