Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (44 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 2.23 KB

Contributing

If you have an idea or feature request please open an issue, even if you don't have time to contribute!

Making Changes

Note: This guide assumes you have a working Python installation (most versions are supported) and have the Python Package Installer available in the current user's $PATH.

To get started, fork this repository on GitHub and clone a working copy for development:

$ git clone git@github.com:YOUR-USERNAME/sensorpush-ha.git

Once cloned, change the directory to your working copy, create a new virtual environment, and activate:

$ python -m venv venv
$ source venv/bin/activate

Dependencies are managed via setuptools; to set up the environment for development, issue:

$ python -m pip install -e .

If user-facing changes are introduced, be sure add an entry to the Unreleased section in CHANGELOG.md.

Finally, commit your changes and create a pull request against the default branch for review.

To make a new release, follow these steps:

  1. Create a new section in CHANGELOG.md for the new version, and move items from Unreleased to this section. Links should also be updated to point to the correct tags for comparison.

  2. Commit outstanding changes by issuing:

    $ git commit -a -m "Release v<version>"

  3. Push changes to the remote repository and verify the results of the CI workflow:

    $ git push origin <default-branch>

  4. Create a release tag by issuing:

    $ git tag -a -m "Release v<version>" v<version>

  5. Push the release tag to the remote repository and verify the results of the Release workflow:

    $ git push origin --tags

License

By contributing to this repository, you agree that your contributions will be licensed under its Simplified BSD License.