mkdocs-material/CONTRIBUTING.md

60 lines
2.6 KiB
Markdown
Raw Normal View History

2016-12-29 20:35:07 +03:00
# Contributing
2023-04-04 15:58:40 +03:00
Material for MkDocs is an actively maintained and constantly improved project
that serves a diverse user base with varying backgrounds and needs. In order to
effectively address the needs of all our users, evaluatgit e requests, and fix bugs,
we maintainers need to put in a lot of work. We have devoted significant effort
to creating better templates for our issue tracker, optimizing the processes for
our users to report bugs, request features or changes, contribute to the
project, or exchange with our community.
Given the wealth of valuable knowledge contained in numerous issues and
discussions, we consider our [issue tracker] and [discussion board] to serve as a
crucial __knowledge base__ that is an important addition to our [documentation]
and brings value to both new and experienced users of Material for MkDocs.
## How to contribute
Selecting the appropriate contribution template is essential to maintain the
organization, searchability, and ease of use of this knowledge base. In this
section of our documentation, we outline the available options and their
respective procedures.
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
2021-11-07 20:23:01 +03:00
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
2023-04-04 15:58:40 +03:00
[documentation]: https://squidfunk.github.io/mkdocs-material/
2023-04-04 15:58:40 +03:00
### Creating an issue
2023-04-04 15:58:40 +03:00
- #### [Report a bug][report a bug]
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
__Something is not working?__ Report a bug in Material for MkDocs by creating an issue with a reproduction
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
- #### [Report a docs issue][report a docs issue]
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
__Missing information in our docs?__ Report missing information or potential inconsistencies in our documentation
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
- #### [Request a change][request a change]
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
__Want to submit an idea?__ Propose a change or feature request or suggest an improvement
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
- #### [Ask a question][ask a question]
2023-04-04 15:58:40 +03:00
__Have a question or need help?__ Ask a question on our discussion board and get in touch with our community
2023-04-04 15:58:40 +03:00
### Contributing to this project
2023-04-04 15:58:40 +03:00
- #### [Add a translation](https://github.com/squidfunk/mkdocs-material/adding-a-translation)
__Missing support for your language?__ Add missing translations for a new or supported language
2016-12-29 20:35:07 +03:00
2023-04-04 15:58:40 +03:00
- #### [Create a pull request](https://github.com/squidfunk/mkdocs-material/creating-a-pull-request)
__Want to create a pull request?__ Learn how to create a comprehensive pull request (PR)
2023-04-04 15:58:40 +03:00
[report a bug]: reporting-a-bug.md
[report a docs issue]: reporting-a-docs-issue.md
[request a change]: requesting-a-change.md
[ask a question]: https://github.com/squidfunk/mkdocs-material/discussions