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
This commit is contained in:
Oncleben31
2020-05-03 09:50:31 +02:00
committed by GitHub
parent 15c2139381
commit 411ea16668
5 changed files with 63 additions and 5 deletions

View File

@ -16,7 +16,8 @@ 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. Issue that pull request!
4. Test you contribution.
5. Issue that pull request!
## Any contributions you make will be under the MIT Software License
@ -24,7 +25,7 @@ In short, when you submit code changes, your submissions are understood to be un
## Report bugs using Github's [issues](../../issues)
GitHub issues are used to track public bugs.
GitHub issues are used to track public bugs.
Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
## Write bug reports with detail, background, and sample code
@ -45,6 +46,16 @@ People *love* thorough bug reports. I'm not even kidding.
Use [black](https://github.com/ambv/black) to make sure the code follows the style.
## Test your code modification
This custom component is based on [blueprint template](https://github.com/custom-components/blueprint).
It comes with development environement 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`](https://github.com/oncleben31/ha-pool_pump/blob/master/.devcontainer/configuration.yaml)
file.
## License
By contributing, you agree that your contributions will be licensed under its MIT License.