Skip to content

Latest commit

 

History

History
121 lines (82 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

121 lines (82 loc) · 3.39 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/gpongelli/broadlink-listener/issues .

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

broadlink-listener could always use more documentation, whether as part of the official broadlink-listener docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/gpongelli/broadlink-listener/issues .

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up broadlink-listener for local development:

  1. Fork the broadlink-listener repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/broadlink-listener.git

  3. Ensure poetry is installed.

  4. Install dependencies and start your virtualenv:

    $ poetry update
$ poetry install --with devel

  5. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  6. When you're done making changes, check that your changes pass flake8 and tests, including testing other Python versions, with tox:

     $ poetry run tox -e format -e lint

  7. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  8. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md .
  3. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11. Check repo action and make sure that the tests pass for all supported Python versions.

Tips

$ poetry run pytest tests/test_cli.py

To run a subset of tests.

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed, be sure to follow Conventional Commits so CHANGELOG.md file will automatically filled by commitizen tool. Then run:

$ poetry run cz bump
$ git push
$ git push --tags

GitHub Actions will then deploy to PyPI if tests pass.