Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

61 lines (35 loc) · 2.58 KB
Raw

Contributing to CorreoMQTT

:1: Thank your for taking time to contribute.

In the following we try to define some guidelines to get involved.

Table Of Contents

Code of Conduct

I just have a question?

How to Contribute

Code of Conduct

By participating, you are expected to agree to the Code Of Conduct. In case this code is not respected, please report to correomqtt-security@exxeta.com.

I just have a question

Please do not file an issue to ask questions!

Please use Github Discussions, you will find it here: CorreoMQTT Github Discussions

How to Contribute

Report a bug

Before submitting a bug

  • Check the discussions, if the problem is already on the table.
  • Check the existing issues, if the problem is already reported.
  • Determine if it is a core or a plugin issue.

Submit the bug

  • Submit the bug using the bug template in issues. If your bug belongs to a plugin, use the plugin issues.

Suggest an enhancement

Before submitting an enhancement

  • Check the discussions, if the idea is already on the table.
  • Check the existing issues, if a similiar feature is already submitted. Consider to add your idea there.
  • Determine if it is a core or a plugin issue.

Submit the enhancement

  • Submit the enhancement using the feature template in issues. If your idea belongs to a plugin, use the plugin issues.

Contribute code

  • Search existing issues or plugin issues for something you want to contribute. If you want to implement something different consider to create a bug or enhancement before.
  • As soon as you decided to implement something, please comment the issue. If it fits we will assign you.
  • Fork the repository and start implementing.
  • After you finsished with implementation and do all the checks e.g. coding guidlines, please file a PR.