Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 973 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 973 Bytes

Contributing with HomeSetup

Thank you for your interest using HomeSetup.

You are welcome to contribute with the project by following the guidelines below:

  1. Format your code accordingly, using the .editorconfig file provided.
  2. If you write bats tests for your code, it will be approved faster.
  3. Use ShellCheck to make sure your code has a "good smell".
  4. Provide a meaningful help using the Help template.
  5. Commits to the repository must follow the commit-templates.
  6. Create a fork with an adequate name.
  7. Provide/Update the User Handbook for your changes if applicable.
  8. Follow the Pull Request Template

You can contribute in many ways:

  • Adding a feature request.
  • Reporting bugs and issues.
  • Supporting us with donations.
  • Providing CONSTRUCTIVE feedback.

Best Regards.