docs/README.md

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

2021-11-29 15:29:07 +03:00
# GitHub Docs <!-- omit in toc -->
2013-01-08 15:55:39 +04:00
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.
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
## Contributing
See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project.
We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code.
2020-10-06 02:21:26 +03:00
2022-01-13 00:08:11 +03:00
On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes.
2020-10-06 02:21:26 +03:00
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
2022-01-13 00:08:11 +03:00
For more complex contributions, you can 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.
If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions.
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
2021-08-27 19:58:57 +03:00
If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
2020-10-06 01:31:14 +03:00
2021-08-27 19:58:57 +03:00
That's how you can easily become a member of the GitHub Documentation 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)
- [includes/liquid-tags/README.md](includes/liquid-tags/README.md)
- [includes/README.md](includes/README.md)
- [components/README.md](components/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](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:!