Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 2.24 KB

CONTRIBUTING.md

Contributing

Thank you for considering contributing to this project! Your support is greatly appreciated. Please read the following guidelines before making any contributions.

Code of Conduct

We strive to maintain an open and welcoming environment for everyone. Please be respectful and courteous to all contributors. Harassment, discrimination, or any form of unprofessional behavior will not be tolerated.

How Can You Contribute?

Reporting Bugs

  1. Check Existing Issues:

    • Ensure that the bug hasn't already been reported.
  2. Create a New Issue:

    • Provide a clear and concise description of the problem.
    • Include steps to reproduce the issue, the expected behavior, and the actual behavior.
    • Add any relevant screenshots or logs if applicable.

Suggesting Enhancements

  1. Feature Request:
    • Verify if the feature has already been suggested or implemented.
    • Open a new issue with a detailed description of the proposed feature and its benefits.

Submitting Pull Requests

  1. Fork the Repository:

    • Click the "Fork" button at the top right of this page to create a copy of the repository in your GitHub account.
  2. Clone Your Fork:

    git clone https://github.com/TCzerny/modbus_manager.git
  3. Create a New Branch:

    git checkout -b feature/YourFeatureName
  4. Make Your Changes:

    • Implement your feature or bug fix.
    • Ensure your code follows the project's coding standards.
  5. Commit Your Changes:

    git commit -m "Add feature: Your Feature Description"
  6. Push to Your Fork:

    git push origin feature/YourFeatureName
  7. Open a Pull Request:

    • Navigate to the original repository and click on "Compare & pull request".
    • Provide a clear description of your changes and the reason for the pull request.

Code Guidelines

  • Style: Adhere to the existing code style and conventions used in the project.
  • Documentation: Comment your code where necessary and update documentation as needed.
  • Testing: Write tests for your changes if applicable to ensure functionality remains intact.

Local Testing

Ensure all tests pass locally before submitting a pull request: