Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.75 KB

Contribution Guidelines

First of all, thanks for thinking of contributing to this project!

Following these guidelines to develop this open source project ensures that both sides are respected, because nobody wants hard work in form of a Pull Request rejected because it isn't compatible with the underlying concept/idea.

❤️ Ways to Contribute

  • Blog or tweet about the project
  • Improve documentation
  • Fix a bug
  • Implement a new feature
  • Discuss potential ways to improve project
  • Improve existing implementation, performance, etc.

🛎 Questions, Issues & Feature Requests

You can open a ticket with your questions or issues any time. Feature requests are also welcome, please describe the feature, why you need it, and how it should work. For all requests, please provide as much detail and context as possible, this ensures that they can be addressed without a lot of back and forth.

🐛 File a Bug

In case you've encountered a bug, please make sure:

  • You are using the latest version.
  • You have read the technical documentation and the user documentation first, and double-checked your configuration.
  • In your issue description, please include:
    • Error Description: What you expected to see, and what happened instead.
    • Steps to Reproduce: A list of the steps to reproduce the issue.
    • Environment info: Your operating system and other environment information.
    • Additional Info: As much information as possible, such as the command and configuration used, logs from a verbose and/or debug run, etc.