docs/README.md

59 строки
3.4 KiB
Markdown
Исходник Обычный вид История

# GitHub Docs <!-- omit in toc -->
This repository contains the documentation website code and Markdown source files for [docs.github.com](https://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.
2024-01-16 22:47:24 +03:00
Use the table of contents icon <img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to navigate to a specific section quickly.
## Contributing
2023-10-02 17:44:22 +03:00
We accept different types of contributions, including some that don't require you to write a single line of code. For detailed instructions on how to get started with our project, see "[About contributing to GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)."
2023-10-02 17:44:22 +03:00
### Ways to contribute
2024-01-16 22:47:24 +03:00
2023-10-02 17:44:22 +03:00
On the GitHub Docs site, you can contribute by clicking the **Make a contribution** button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes.
You can also contribute by creating a local environment or opening a Codespace. For more information, see "[Setting up your environment to work on GitHub Docs](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs)."
2020-10-06 02:21:26 +03:00
2024-01-16 22:47:24 +03:00
<img alt="Contribution call-to-action" src="./contributing/images/contribution_cta.png" width="400">
2020-10-06 01:31:14 +03:00
2023-10-02 17:44:22 +03:00
For more complex contributions, please open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see.
2024-01-16 22:47:24 +03:00
If you're looking for a way to contribute, you can scan through our [help wanted board](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) to find open issues already approved for work.
2020-10-08 01:00:46 +03:00
2021-08-27 19:58:57 +03:00
### Join us in discussions
2020-10-06 01:31:14 +03:00
2021-10-20 11:24:43 +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 the [discussions](https://github.com/github/docs/discussions).
2021-08-27 19:58:57 +03:00
### And that's it!
2020-11-19 17:04:18 +03:00
If you're having trouble with your GitHub account, contact [Support](https://support.github.com).
2020-10-06 01:31:14 +03:00
That's how you can easily become a member of the GitHub Docs community. :sparkles:
2020-10-06 00:44:29 +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)
- [content/graphql/README.md](content/graphql/README.md)
- [content/rest/README.md](content/rest/README.md)
- [contributing/README.md](contributing/README.md)
- [data/README.md](data/README.md)
- [data/reusables/README.md](data/reusables/README.md)
- [data/variables/README.md](data/variables/README.md)
- [src/README.md](src/README.md)
## License
The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE).
All other code in this repository is licensed under the [MIT license](LICENSE-CODE).
2022-01-13 00:08:11 +03:00
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
2021-08-27 19:58:57 +03:00
## Thanks :purple_heart:
2022-07-04 18:48:43 +03:00
Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:!