Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 1.84 KB
Raw

Contributing

Thank you for your interest in helping out with this project.

Two very straighforward ways of getting involved are:

  • Issues
    • looking at issues raised and trying to advise users looking for help, or encouraging them to obtain useful diagnostics
  • Documentation

If you want to take things further you can get involved with code, either to deal with issues raised or to develop new features.

Development

As you will use a fork for your development we encourage you to familiarise yourself with the Github guide to working with forks.

All development work should be done on branches created from the dev branch. Please ensure you understand the branching model we follow.

Both of the above-linked guides also include command examples for you to work on your local project repository.

Please raise an issue if you want further guidance on developing new features or fixing issues.

Once you have completed your development and testing on your changes, then please raise a Pull Request for us to be able to merge in your work. They should be merged into the dev branch.

Release

When delivering new changes to this project you should include the following procedures:

  • CHANGELOG.md

    • add entries for each sustantive change to the Unreleased section
    • these can be based on the 'commit' comments from contributors

  • Set the Tag name for the Release to be the same as the version

  • Will we need to Zip the relase? If so mark zip_release = true in hacs.json.