Thank you for investing your time in contributing to our project!
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README.
If you spot a problem with MQTT5 Explorer app, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone except our team members. If you find an issue to work on, you are welcome to open a PR with a fix.
-
Install Node.js (we are currently using Node.js v14).
-
Follow the Project setup instruction in the README.
-
Create a working branch and start with your changes!
Commit the changes once you are happy with them. Once your changes are ready, don't forget to self-review to speed up the review process.
When you're finished with the changes, create a pull request, also known as a PR.
-
Don't forget to link PR to issue if you are solving one.
-
Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
-
We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
-
As you update your PR and apply changes, mark each conversation as resolved.
Congratulations 🎉🎉 The MQTT5 Explorer team thanks you ✨.