Skip to content
This repository has been archived by the owner on Oct 30, 2019. It is now read-only.

Latest commit

 

History

History
44 lines (36 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

44 lines (36 loc) · 2.65 KB
Raw

Contributing to Hassbian-scripts

Everybody is invited and welcome to contribute to Hassbian-scripts.

The process is straight-forward.

  • Read How to get faster PR reviews by Kubernetes (but skip step 0)
  • Fork the Hassbian-scripts git repository.
  • Add a new branch to your fork with a name that describes what you are implementing.
  • Add or change the code.
  • Ensure tests work.
  • Ensure tests work. Finding out during review that this does not work, will not result in a good review.
  • Create a Pull Request against the dev branch of Hassbian-scripts.

Pull Requests for new scripts.

All new scripts must meet the following criteria to be considered to be reviewed:

  • Stickler-Ci should report no errors. (this is an automated review process based on shellcheck)
  • The Script must be tested with success locally, see testing your code for tips on how to test.
  • Every script should have a validation at the end, see validation for tips.
  • You must add documentation to the /docs for the script.

PR Naming

Create a good name for your PR, this will be used in the changelog. Good names

  • Suite: Added support for feature X.
  • Hassbian-config: Added function X.
  • New install script for suite.
  • Suite: Fixed typo in function X.
  • Suite docs: Added more information about suite.

Bad names

  • Updated suite.sh
  • Fixed typo.

Description in the PR

Remember that it is people that are reviewing your PR, people that most likely don't share your mindset. A good description of what the PR does, will certanly help during the review prosess.

Comments

Your PR will most likely get comments during the review process, this is not to criticise your work. But feedback on how your PR can better match our "standards", you should have a look at existing scripts in the repo. If some comments are unclear to you, use the thread under that comment to get clarification, or drop a line in the #devs_hassbian channel over at Discord. We want to help you help us getting Hassbian-scripts better.

More info

For more information about contributions in the different sections of the project have a look at the contribution documentation.