mirror of
https://github.com/davestephens/ansible-nas
synced 2024-12-27 03:53:06 +00:00
14 lines
862 B
Markdown
14 lines
862 B
Markdown
|
# 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.
|