|
| 1 | +[Skip to main content](https://docs.github.com/en/contributing#main-content) |
| 2 | +[GitHub Docs](https://docs.github.com/en) |
| 3 | +Version: Free, Pro, & Team |
| 4 | +Search or ask Copilot |
| 5 | +Search or askCopilot |
| 6 | +Select language: current language is English |
| 7 | +[Sign up](https://github.com/signup?ref_cta=Sign+up&ref_loc=docs+header&ref_page=docs) |
| 8 | +Search or ask Copilot |
| 9 | +Search or askCopilot |
| 10 | +Open menu |
| 11 | +Open Sidebar |
| 12 | + * [Contribute to GitHub Docs](https://docs.github.com/en/contributing "Contribute to GitHub Docs") |
| 13 | + |
| 14 | + |
| 15 | +[](https://docs.github.com/en) |
| 16 | +## [Contribute to GitHub Docs](https://docs.github.com/en/contributing) |
| 17 | + * Writing for GitHub Docs |
| 18 | + * [Best practices for GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs) |
| 19 | + * [Documentation philosophy](https://docs.github.com/en/contributing/writing-for-github-docs/about-githubs-documentation-philosophy) |
| 20 | + * [Documentation fundamentals](https://docs.github.com/en/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals) |
| 21 | + * [Content design principles](https://docs.github.com/en/contributing/writing-for-github-docs/content-design-principles) |
| 22 | + * [Write content to be translated](https://docs.github.com/en/contributing/writing-for-github-docs/writing-content-to-be-translated) |
| 23 | + * [Make content findable](https://docs.github.com/en/contributing/writing-for-github-docs/making-content-findable-in-search) |
| 24 | + * [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation) |
| 25 | + * [Markdown and Liquid](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs) |
| 26 | + * [YAML frontmatter](https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter) |
| 27 | + * [Use videos](https://docs.github.com/en/contributing/writing-for-github-docs/using-videos-in-github-docs) |
| 28 | + * [Create reusable content](https://docs.github.com/en/contributing/writing-for-github-docs/creating-reusable-content) |
| 29 | + * [Create screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots) |
| 30 | + * [Create diagrams](https://docs.github.com/en/contributing/writing-for-github-docs/creating-diagrams-for-github-docs) |
| 31 | + * [Create tool switchers](https://docs.github.com/en/contributing/writing-for-github-docs/creating-tool-switchers-in-articles) |
| 32 | + * [Configure redirects](https://docs.github.com/en/contributing/writing-for-github-docs/configuring-redirects) |
| 33 | + * [Change an article's title](https://docs.github.com/en/contributing/writing-for-github-docs/changing-an-articles-title) |
| 34 | + * [Annotate code examples](https://docs.github.com/en/contributing/writing-for-github-docs/annotating-code-examples) |
| 35 | + * [Templates](https://docs.github.com/en/contributing/writing-for-github-docs/templates) |
| 36 | + * Style guide and content model |
| 37 | + * [Style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide) |
| 38 | + * [About the content model](https://docs.github.com/en/contributing/style-guide-and-content-model/about-the-content-model) |
| 39 | + * [Contents of an article](https://docs.github.com/en/contributing/style-guide-and-content-model/contents-of-a-github-docs-article) |
| 40 | + * [About topics](https://docs.github.com/en/contributing/style-guide-and-content-model/about-topics) |
| 41 | + * [Conceptual content type](https://docs.github.com/en/contributing/style-guide-and-content-model/conceptual-content-type) |
| 42 | + * [Referential content type](https://docs.github.com/en/contributing/style-guide-and-content-model/referential-content-type) |
| 43 | + * [Procedural content type](https://docs.github.com/en/contributing/style-guide-and-content-model/procedural-content-type) |
| 44 | + * [Troubleshooting content type](https://docs.github.com/en/contributing/style-guide-and-content-model/troubleshooting-content-type) |
| 45 | + * [Release note content type](https://docs.github.com/en/contributing/style-guide-and-content-model/release-note-content-type) |
| 46 | + * [Quickstart content type](https://docs.github.com/en/contributing/style-guide-and-content-model/quickstart-content-type) |
| 47 | + * [Tutorial content type](https://docs.github.com/en/contributing/style-guide-and-content-model/tutorial-content-type) |
| 48 | + * [Combining multiple types](https://docs.github.com/en/contributing/style-guide-and-content-model/about-combining-multiple-content-types) |
| 49 | + * Collaborate on GitHub Docs |
| 50 | + * [About contributing](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) |
| 51 | + * [Using Git](https://docs.github.com/en/contributing/collaborating-on-github-docs/using-git-on-github-docs) |
| 52 | + * [Using the TODOCS placeholder](https://docs.github.com/en/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes) |
| 53 | + * [Using the content linter](https://docs.github.com/en/contributing/collaborating-on-github-docs/using-the-content-linter) |
| 54 | + * [Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) |
| 55 | + * Your working environment |
| 56 | + * [Working in a codespace](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace) |
| 57 | + * [Create a local environment](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment) |
| 58 | + * [Troubleshooting your environment](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment) |
| 59 | + |
| 60 | + |
| 61 | +# Contributing to GitHub Docs documentation |
| 62 | +Learn about how the GitHub Docs team creates documentation and how you can contribute. |
| 63 | +## Start here |
| 64 | + * ### [Best practices for GitHub Docs Follow these best practices to create documentation that's user-friendly and easy to understand. ](https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs) |
| 65 | + * ### [Style guide Follow this guide to make sure GitHub's documentation stays consistent and follows clear patterns that our readers can understand. ](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide) |
| 66 | + * ### [About the content model The content model describes the structure and types of content that we publish. ](https://docs.github.com/en/contributing/style-guide-and-content-model/about-the-content-model) |
| 67 | + * ### [About contributing to GitHub Docs You can contribute to GitHub Docs content in several ways. ](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) |
| 68 | + |
| 69 | + |
| 70 | +## [All Contribute to GitHub Docs docs](https://docs.github.com/en/contributing#all-docs) |
| 71 | +### [Writing for GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs) |
| 72 | + * [Best practices for GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs) |
| 73 | + * [About GitHub's documentation philosophy](https://docs.github.com/en/contributing/writing-for-github-docs/about-githubs-documentation-philosophy) |
| 74 | + * [About GitHub's documentation fundamentals](https://docs.github.com/en/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals) |
| 75 | + * [Content design principles](https://docs.github.com/en/contributing/writing-for-github-docs/content-design-principles) |
| 76 | + * [Writing content to be translated](https://docs.github.com/en/contributing/writing-for-github-docs/writing-content-to-be-translated) |
| 77 | + * [Making content findable in search](https://docs.github.com/en/contributing/writing-for-github-docs/making-content-findable-in-search) |
| 78 | + * [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation) |
| 79 | + * [Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs) |
| 80 | + * [Using YAML frontmatter](https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter) |
| 81 | + * [Using videos in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-videos-in-github-docs) |
| 82 | + * [Creating reusable content](https://docs.github.com/en/contributing/writing-for-github-docs/creating-reusable-content) |
| 83 | + * [Creating screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots) |
| 84 | + * [Creating diagrams for GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/creating-diagrams-for-github-docs) |
| 85 | + * [Creating tool switchers in articles](https://docs.github.com/en/contributing/writing-for-github-docs/creating-tool-switchers-in-articles) |
| 86 | + * [Configuring redirects](https://docs.github.com/en/contributing/writing-for-github-docs/configuring-redirects) |
| 87 | + * [Changing an article's title](https://docs.github.com/en/contributing/writing-for-github-docs/changing-an-articles-title) |
| 88 | + * [Annotating code examples](https://docs.github.com/en/contributing/writing-for-github-docs/annotating-code-examples) |
| 89 | + * [Templates](https://docs.github.com/en/contributing/writing-for-github-docs/templates) |
| 90 | + |
| 91 | + |
| 92 | +### [Style guide and content model](https://docs.github.com/en/contributing/style-guide-and-content-model) |
| 93 | + * [Style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide) |
| 94 | + * [About the content model](https://docs.github.com/en/contributing/style-guide-and-content-model/about-the-content-model) |
| 95 | + * [Contents of a GitHub Docs article](https://docs.github.com/en/contributing/style-guide-and-content-model/contents-of-a-github-docs-article) |
| 96 | + * [About topics](https://docs.github.com/en/contributing/style-guide-and-content-model/about-topics) |
| 97 | + * [Conceptual content type](https://docs.github.com/en/contributing/style-guide-and-content-model/conceptual-content-type) |
| 98 | + * [Referential content type](https://docs.github.com/en/contributing/style-guide-and-content-model/referential-content-type) |
| 99 | + * [Procedural content type](https://docs.github.com/en/contributing/style-guide-and-content-model/procedural-content-type) |
| 100 | + * [Troubleshooting content type](https://docs.github.com/en/contributing/style-guide-and-content-model/troubleshooting-content-type) |
| 101 | + * [Release note content type](https://docs.github.com/en/contributing/style-guide-and-content-model/release-note-content-type) |
| 102 | + * [Quickstart content type](https://docs.github.com/en/contributing/style-guide-and-content-model/quickstart-content-type) |
| 103 | + * [Tutorial content type](https://docs.github.com/en/contributing/style-guide-and-content-model/tutorial-content-type) |
| 104 | + * [About combining multiple content types](https://docs.github.com/en/contributing/style-guide-and-content-model/about-combining-multiple-content-types) |
| 105 | + |
| 106 | + |
| 107 | +### [Collaborating on GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs) |
| 108 | + * [About contributing to GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) |
| 109 | + * [Using Git on GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/using-git-on-github-docs) |
| 110 | + * [Using the TODOCS placeholder to leave notes](https://docs.github.com/en/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes) |
| 111 | + * [Using the content linter](https://docs.github.com/en/contributing/collaborating-on-github-docs/using-the-content-linter) |
| 112 | + * [Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) |
| 113 | + |
| 114 | + |
| 115 | +### [Setting up your environment to work on GitHub Docs](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs) |
| 116 | + * [Working on GitHub Docs in a codespace](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace) |
| 117 | + * [Creating a local environment](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment) |
| 118 | + * [Troubleshooting your environment](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment) |
| 119 | + |
| 120 | + |
| 121 | +## Help and support |
| 122 | +### Did you find what you needed? |
| 123 | +YesNo |
| 124 | +[Privacy policy](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement) |
| 125 | +### Help us make these docs great! |
| 126 | +All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request. |
| 127 | +[](https://github.com/github/docs/blob/main/content/contributing/index.md) |
| 128 | +[Learn how to contribute](https://docs.github.com/contributing) |
| 129 | +### Still need help? |
| 130 | +[](https://github.com/orgs/community/discussions) |
| 131 | +[](https://support.github.com) |
| 132 | +## Legal |
| 133 | + * © 2026 GitHub, Inc. |
| 134 | + * [Terms](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service) |
| 135 | + * [Privacy](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement) |
| 136 | + * [Status](https://www.githubstatus.com/) |
| 137 | + * [Pricing](https://github.com/pricing) |
| 138 | + * [Expert services](https://services.github.com) |
| 139 | + * [Blog](https://github.blog) |
0 commit comments