Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 2.95 KB

Contributing to HomeServeMate

Thank you for considering contributing to HomeServeMate! We welcome contributions from the community and are grateful for your support. To ensure a smooth process, please follow the guidelines below.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the HomeServeMate Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to email.

How Can I Contribute?

Reporting Bugs

If you encounter a bug, please open an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A description of the steps to reproduce the issue.
  • The expected and actual results.
  • Any relevant logs, screenshots, or other information.

Suggesting Enhancements

We welcome suggestions to improve HomeServeMate. Please open an issue on GitHub with the following details:

  • A clear and descriptive title.
  • A detailed explanation of the enhancement and why it would be useful.
  • Any examples or use cases where this enhancement would be beneficial.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix (git checkout -b feature-name).
  3. Make your changes.
  4. Ensure that your code follows the project's coding style and passes all tests.
  5. Commit your changes with a descriptive commit message.
  6. Push your branch to your forked repository (git push origin feature-name).
  7. Open a pull request on GitHub, providing a clear and detailed description of your changes.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Keep the subject line to 50 characters or less.
  • Include a detailed explanation of the changes in the body, if necessary.

Code Style

  • Follow the coding conventions used in the project.
  • Maintain consistency with the existing codebase.
  • Ensure that your code is properly documented.

Additional Notes

  • We may suggest changes to your pull request. Don’t be discouraged! We want to ensure that all contributions align with the project's goals and quality standards.
  • If you plan to make significant changes, please open an issue first to discuss your ideas.
  • Feel free to ask for help or clarification at any point during the contribution process.

Thank you for your contributions!

By contributing to this project, you agree to abide by the HomeServeMate Code of Conduct.