Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

19 lines (13 loc) · 1.04 KB
Raw

How to contribute

Submitting bugs

When reporting a bug please include as much information as possible. Include the output of the plugin with the -verbose and -debug options.

If possible give a real-life example that can be tested (e.g., a public host).

If you do not want that the host name is published a bug report, but the host is reachable from the internet, please send me the host name per email (matteo@corti.li) so that I can test. I will keep the host name confidential.

Submitting changes

  • Always write clear log messages for your commits
  • Check the code with ShellCheck (make shellckeck)
  • Always format the code with shfmt
  • Check the spelling with codespell (make codespell)
  • Always log your changes in the ChangeLog file
  • Always test the changes make test and be sure that all the tests are passed
  • If possible write some tests to validate the changes you did to the plugin