Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2024-12-27 03:53:06 +00:00
Code Issues Projects Releases Packages Wiki Activity
ansible-nas/CONTRIBUTING.md
David Stephens 1454fed093 Update contribution guidelines
2020-01-05 09:14:42 +00:00

1.3 KiB
Raw Blame History

Contributing

Contributing to Ansible-NAS is easy! Add your functionality, then raise a pull request on GitHub. A few things to bear in mind:

  • Restrict pull requests to one piece of functionality or bugfix at a time.
  • Test your new functionality or bugfix using the included tests/test-vagrant.sh script to spin up a test VM.
  • Run ansible-lint against the playbook before committing. (There is a VSCode task set up to run the right command for you)
  • Ensure that your PR only changes files required for your functionality or bugfix.

If you're adding a new application:

  • Ensure that the new application is disabled by default.
  • Add a documentation page to docs/applications/ - use an existing application as an example.
  • Add the frontend port to docs/configuration/application_ports.md, ensuring you've not clashed with an existing application.

Things to bear in mind

  • If you break the build with your PR, please fix it :)
  • Pull requests that unintentionally touch files, or that show files as removed then re-added will be rejected.
  • Please know that your efforts are appreciated, thanks! 👍

Development Environment

  • Development of Ansible-NAS is carried out in Visual Studio Code - you'll get some nice recommended extensions and task setups if you do the same.