Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 2.4 KB

Contributing to SMS Modem MQTT Broker

Thank you for considering contributing to the SMS Modem MQTT Broker! Your contributions are highly appreciated, and they help improve the project for everyone. Please take a moment to review the following guidelines to ensure a smooth collaboration.

How Can You Contribute?

  • Report Issues: If you encounter any bugs, issues, or unexpected behavior, please report them by opening a new issue in the issue tracker. Provide a detailed description, steps to reproduce, and any relevant information that can help identify and resolve the problem.

  • Suggest Enhancements: If you have ideas for new features, improvements, or enhancements, feel free to open an issue in the issue tracker and describe your suggestion. We appreciate your input and are open to new ideas.

  • Contribute Code: If you would like to contribute code to the project, follow these steps:

    1. Fork the repository and create a new branch for your feature or bug fix.
    2. Implement your changes, ensuring clear and concise code with appropriate documentation.
    3. Test your changes to ensure they work as intended.
    4. Submit a pull request (PR) to the main branch of the original repository.
    5. Include a detailed description of your changes in the PR, explaining the problem it solves or the enhancement it provides.

Code Guidelines

  • Follow the existing code style and conventions to maintain consistency throughout the project.
  • Write clear and concise commit messages, explaining the purpose and impact of each commit.
  • Ensure your code changes include appropriate documentation to help other developers understand and utilize the new features or modifications.

License

By contributing to the SMS Modem MQTT Broker, you agree that your contributions will be licensed under the MIT License of the project. This ensures that your contributions can be used, modified, and distributed by others in accordance with the license terms.

Code of Conduct

Please note that as a contributor, you are expected to adhere to the Code of Conduct of the project. Be respectful and considerate towards others, fostering a welcoming and inclusive environment for collaboration.

We appreciate your efforts and contributions in improving the SMS Modem MQTT Broker. Thank you for your support!