Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.3 KB

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, 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 and brings value to both new and experienced users of Material for MkDocs.

How to contribute

Creating an issue

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

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

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

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

Contributing

  • [Add a translation]

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

  • Want to create a pull request? Learn how to create a comprehensive and useful pull request (PR)s