Contributing guidelines

Here's how to work with us and make useful products.

How to ask a question

  • Start a new discussion for each question.
  • Write the question in the title, so that everyone can see what it is about.
  • Describe what you want to do and which problems you have.
  • Select an answer, when your question has been answered.

How to report a bug

  • Start a new discussion for each bug.
  • Explain how to reproduce the bug, check if it happens every time.
  • Add many details, check the log file system/extensions/yellow.log.
  • Test that everything works, when your problem has been fixed.

How to improve the documentation

  • Start with the help, individual extensions or a translation.
  • Edit the existing documentation or make a translation.
  • Upload your documentation to GitHub, let us know if you need help.
  • Check that it is helpful to the user and give many practical examples.

How to develop your own extensions

  • Start with an example feature, example theme or the API.
  • Imagine what the user wants to do, aim for a simple solution.
  • Upload your extensions to GitHub, let us know if you need help.
  • First make it work, then make it better.

Tips for new contributors

Our community is a place to help each other. Where you can ask and answer questions. Most answers are provided by community members, just like you. Consider that other people may not have the same experience level or background as you. Never feel compelled to react or respond to anyone. You can step out of conversations at any time if the discussion isn't constructive. Focus on the people who want to help you. Imagine what we can do if we're working together.

Let us know how we can create a good work environment for you. Collaboration works best when you enjoy what your are doing. When you're surrounded by helpful people. Understanding people's needs and problems is a central part of product development. Our job is not to bring more technology, more features and more documentation into people's lives. Our first task is to remove problems from people's lives. Our second task is to find like-minded people and work together.

Say hello to the community. You can find us on Discord, GitHub, Twitter or contact a human.