1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-09-23 19:08:25 +02:00
mkdocs-material/CONTRIBUTING.md
katharinalisalin 268c5066ba Updated guides
2023-04-04 14:58:40 +02:00

2.6 KiB

Contributing

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.

Creating an issue

  • Report a bug

    Something is not working? Report a bug in Material for MkDocs by creating an issue with a reproduction

  • Report a docs issue

    Missing information in our docs? Report missing information or potential inconsistencies in our documentation

  • Request a change

    Want to submit an idea? Propose a change or feature request or suggest an improvement

  • Ask a question

    Have a question or need help? Ask a question on our discussion board and get in touch with our community

Contributing to this project

  • Add a translation

    Missing support for your language? Add missing translations for a new or supported language

  • Create a pull request

    Want to create a pull request? Learn how to create a comprehensive pull request (PR)