Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.71 KB

Contributing to Homematic 2024

Thank you for your interest in contributing to Homematic 2024! By contributing, you can help improve the app and make it more useful for everyone. Please follow these guidelines to ensure a smooth contribution process.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub. Provide as much detail as possible, including steps to reproduce the bug, the expected behavior, and what actually happens. If possible, include screenshots or error messages.

Suggesting Features

If you have an idea for a new feature, please create an issue on GitHub. Describe the feature in detail and explain why it would be useful. If you have any suggestions for how the feature should be implemented, please include those as well.

Adding Code

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.

  2. Clone Your Fork: Clone your fork to your local machine.

    git clone https://github.com/your-username/homey-matic.git
cd homey-matic

  3. Create a New Branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Your Changes: Implement your changes in the codebase.

  5. Commit Your Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add feature: your feature name"

  6. Push to Your Fork: Push your changes to your fork on GitHub.

    git push origin feature/your-feature-name

  7. Create a Pull Request: Go to the original repository and create a pull request from your fork. Provide a clear description of your changes and why they should be merged.

Code Guidelines

Coding Standards

  • Write clear, concise, and understandable code.
  • Follow the existing code style and conventions.
  • Use meaningful variable and function names.

Testing

  • Ensure your changes do not break existing functionality.
  • Write tests for new features and bug fixes when applicable.

Documentation

  • Update the documentation to reflect your changes, including the README.md and any relevant comments in the code.
  • Ensure that any new features are clearly explained and documented.

Communication

Issues

  • When creating or commenting on issues, be respectful and constructive.
  • Provide as much detail as possible to help others understand the issue or suggestion.

Pull Requests

  • Review the pull request template and ensure all items are completed.
  • Be open to feedback and willing to make necessary changes.

Thank you for contributing to Homematic 2024! Your efforts are greatly appreciated and help make the project better for everyone.