1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-22 04:16:03 +01:00
mkdocs-material/CONTRIBUTING.md

63 lines
2.3 KiB
Markdown
Raw Normal View History

2016-12-29 18:35:07 +01:00
# Contributing
2023-09-21 14:53:33 +02: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, evaluate change 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]
2023-04-04 14:58:40 +02:00
and brings value to both new and experienced users of Material for MkDocs.
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
2021-11-07 18:23:01 +01:00
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
2023-04-04 14:58:40 +02:00
[documentation]: https://squidfunk.github.io/mkdocs-material/
2023-09-21 14:53:33 +02:00
## How to contribute
2023-04-04 14:58:40 +02:00
### Creating an issue
2023-09-21 14:53:33 +02:00
- #### [Report a bug]
2023-09-21 14:53:33 +02:00
__Something is not working?__ Report a bug in Material for MkDocs by
creating an issue with a reproduction
2023-09-21 14:53:33 +02:00
- #### [Report a docs issue]
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
__Missing information in our docs?__ Report missing information or
potential inconsistencies in our documentation
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
- #### [Request a change]
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
__Want to submit an idea?__ Propose a change, feature request, or
suggest an improvement
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
- #### [Ask a question]
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
__Have a question or need help?__ Ask a question on our [discussion board]
and get in touch with our community
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
### Contributing
2023-09-21 14:53:33 +02:00
- #### [Add a translation]
2023-09-21 14:53:33 +02:00
__Missing support for your language?__ Add missing translations for a new
or already supported language
2023-09-21 14:53:33 +02:00
- #### [Create a pull request]
2016-12-29 18:35:07 +01:00
2023-09-21 14:53:33 +02:00
__Want to create a pull request?__ Learn how to create a comprehensive
and useful pull request (PR)s
2024-04-18 02:30:52 +02:00
[Report a bug]: docs/contributing/reporting-a-bug.md
[Report a docs issue]: docs/contributing/reporting-a-docs-issue.md
[Request a change]: docs/contributing/requesting-a-change.md
2023-09-21 14:53:33 +02:00
[Ask a question]: https://github.com/squidfunk/mkdocs-material/discussions
2024-04-18 02:30:52 +02:00
[Add a translation]: docs/contributing/adding-translations
[Create a pull request]: docs/contributing/making-a-pull-request.md