Skip to content

Latest commit

 

History

History
58 lines (31 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

58 lines (31 loc) · 2.37 KB
Raw

Contributing

How to contribute to HomeGenie

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of HomeGenie will generally not be accepted unless discussed via the issue tracker.

Do you intend to add a new feature or change an existing one?

File a new enhancement issue.

Do you have questions about the source code?

File a new question issue.

Do you want to contribute to the HomeGenie documentation?

Source code of the documentation site is available from homegenie.it repository.

Coding styles and conventions

This project follows Microsoft .Net coding conventions and naming guidelines.

Releasing a new version

To release a new version push a new tag using the format:

v<major>.<minor>.<patch>-{rc|beta|alpha}.<build>

example: v1.4.0-beta.25

When a new tag is submitted the CI system will build the project, run tests and package assets. Assets will be also uploaded to the new release on GitHub repository.

Join HomeGenie team!

HomeGenie is a volunteer effort. We encourage you to pitch in and join the team!

Thanks! ❤️