alex/octopusenergy-hass
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
octopusenergy-hass/CONTRIBUTING.md
ludeeus d51d010901
init 
fix action

Action commit

Created package file

minor updates

Add binary_sensor

Updated package file

Updated package file

Fix BinarySensor Class name

Add more descriptions

Updated package file

Move stuff

Updated package file

add binary_sensor to resources.json

Updated package file

Add configuration

Updated package file

Remove switch

Adds CONTRIBUTING

Fix broken link

Remove refrences

Fix links

fix broken actions

Update actions

Updated package file

Updated package file

Black format

Fix config issues

Updated package file

Fix icon for binary_sensor

Add switch platform

Update README.md (#1)

* Update README.md

* Update README.md

Update CONTRIBUTING.md (#2)

Update __init__.py (#3)

* Update __init__.py

* Set enabled default to `True`

Update const.py (#4)

cleanup badges/add style (#5)

* shield that supports styling

* badge cleanup

* Change discord ID

Correct typo

Create manifest.json (#12)

Fixes https://github.com/custom-components/blueprint/issues/10

Move manifest to correct dir

Fixes #9 by renaming the file

Updates, updates, more updates, worst commit messge ever!

revert

Update main.workflow

Delete resources.json

Create example.yaml

Update README.md

Summer update 😎

Adds info about devcontainer

Adds pylint

Add translation example

remove stalebot

Adds integrationhelper

adds requirements.txt

Adds "tabnine.tabnine-vscode" to devcontainer

Add support for config_flow configuration

Add config_flow "docs"

Update README.md

use https for pip install ha@dev (#15)

Typo on README.md (#18)

Fix various typos in comments (#19)

Add hassfest action (#22)

* Add hassfest action

* Fix manifest issue

Spring cleaning ☀️ (#23)

* Spring cleaning

* Actions

* Fix branches

* Changes for config_flow

Show how to only allow one instance

Adds HACS validation action (#24)

Update postCreateCommand

Update tasks

Minor updates (#26)

* link correction in README.md and info.md

* Add READMME.md for .devcontainer

* Add automation.yaml file in the configuration

* Complete CONTRIBUTING.md

Improve README for container dev and library update. (#27)

Feature/setup cfg (#28)

* Add setup.cfg

* Run black and isort.

* Add blueprint to first party.

* Make const import consistent.

Move translation files

Fixes #32

Use CoordinatorEntity (#33)

Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>

Fixed typos (#34)

Fix directory name for translations and link to the documentation (#36)

Fix info.md (#40)

Use debian based devcontainer (#44)

Remove sampleclient (#45)

Rename [blueprint|Blueprint] -> [integration_blueprint|Integration blueprint] (#47)

Change HACS action (#39)

Fix wrong path for link (#48)

For an unknown reason the link was pointing to a one of my repository.
Probably a too quick copy/paste.

Add french translation and strings improvements (#49)

Reusing work done on strings.json done in #37

Add example tests (#50)

Prepare and explain how to step by step debugging (#51)

Add version

Fix testing by bumping pytest-homeassistant-custom-component (#54)

Fix typo in api.py (#55)

passeword -> password

Fix a typo in the readme (#56)

Update .gitignore to include .idea (#57)

Update .gitignore to include .idea for those using Py Charm

Add iot_class to manifest

Use `enable_custom_integrations` fixture by default (#58)

Fix typo (#59)

retain user input after an error (#52)

Update README.md

Closes #61

remove async_timeout.timeout loop arg (#65)

Correct name "Blueprint" ->"Integration blueprint" (#64)

change entity.py to use extra_state_attributes (#66)
2021-12-11 11:43:43 +00:00

2.2 KiB
Raw Permalink Blame History

Contribution guidelines

Contributing to this project should be as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Github is used for everything

Github is used to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase.

  1. Fork the repo and create your branch from master.
  2. If you've changed something, update the documentation.
  3. Make sure your code lints (using black).
  4. Test you contribution.
  5. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

GitHub issues are used to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

Use black to make sure the code follows the style.

Test your code modification

This custom component is based on integration_blueprint template.

It comes with development environment in a container, easy to launch if you use Visual Studio Code. With this container you will have a stand alone Home Assistant instance running and already configured with the included .devcontainer/configuration.yaml file.

License

By contributing, you agree that your contributions will be licensed under its MIT License.