Skip to content

Contributing⚓︎

Freenahi is an actively maintained and constantly evolving project serving a diverse user base with versatile backgrounds and needs. In order to efficiently address the requirements of all our users, evaluate change requests, and fix bugs, we put in a lot of work.

How you can contribute⚓︎

In this section, we guide your through our processes.

  •   Something is not working?

    Report a bug in Material for MkDocs by creating an issue with a reproduction

    Report a bug

  •   Missing information in our docs?

    Report missing information or potential inconsistencies in our documentation

    Report a docs issue

  •   Want to submit an idea?

    Propose a change, feature request, or suggest an improvement

    Request a change

  •   Have a question or need help?

    Ask a question on our discussion board and get in touch with our community

    Ask a question

Contributing⚓︎

  •   Missing support for your language?

    Add or improve translations for a new or already supported language

    Add translations

  •   Want to create a pull request?

    Learn how to create a comprehensive and useful pull request (PR)

    Create a pull request

Checklist⚓︎

Before interacting within the project, please take a moment to consider the following questions. By doing so, you can ensure that you are using the correct issue template and that you provide all necessary information when interacting with our community.

Issues, discussions, and comments are forever

Please note that everything you write is permanent and will remain for everyone to read – forever.
Therefore, please always be nice and constructive.

Before creating an issue⚓︎

  • Have you checked if a similar bug report or change request has already been created, or have you stumbled upon something that might be related?

  • Did you fill out every field as requested and did you provide all additional information we maintainers need to comprehend your request?

Before asking a question⚓︎

  • Is there an open discussion on the topic of your request? If the answer is yes, does your question match the direction of the discussion, or should you open a new discussion?

  • Did your provide our community with all the necessary information to understand your question and help you quickly, or can you make it easier to help you?

Before commenting⚓︎

  • Is your comment relevant to the topic of the current page, post, issue, or discussion, or is it a better idea to create a new issue or discussion?

  • Does your comment add value to the conversation? Is it constructive and respectful to our community and us maintainers? Could you just use a reaction instead?

Rights and responsibilities⚓︎

As maintainers, we are entrusted with the responsibility to moderate communication within our community, including the authority to close, remove, reject, or edit issues, discussions, comments, commits, and to block users who do not align with our contribution guidelines.
This role requires us to be actively involved in maintaining the integrity and positive atmosphere of our community. Upholding these standards decisively ensures a respectful and inclusive environment for all members.