Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2024-11-14 16:07:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
David Stephens 2022-08-20 19:05:54 +01:00 committed by GitHub
parent 5ad87cbdd4
commit 01bdc8e8b6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -2,26 +2,23 @@
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.
* **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.
* Ensure that your PR only changes files required for your functionality or bugfix. Random changes in other files will result in your PR being rejected
If you're adding a new application:
* It must be structured in an [Ansible role](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html).
* Ensure that the new application is disabled by default.
* Add a documentation page to `docs/applications/` - use an existing application as an example.
* Add to the list of Available Applications in `README.md`
* Add the frontend port to `docs/configuration/application_ports.md`, ensuring you've not clashed with an existing application.
* Add to the list of certificate requests in `templates/traefik/traefik.toml` if the program is to be used externally.
A typical new application PR will include 2 new files (`docs/applications/application.md` and `tasks/application.yml`) and have 5 updated files (`README.md`, `nas.yml`, `docs/configuration/application_ports.md`, `group_vars/all.yml`, `templates/traefik/traefik.toml`).
## Things to bear in mind
* If you break the build with your PR, please fix it :)
* If you break the build with your PR, it'll need to be fixed before it's merged.
* Pull requests that unintentionally touch files, or that show files as removed then re-added will be rejected.
* Squash your commits before creating a PR.
* Don't mess with line endings, or tabs vs. spaces.
* Please know that your efforts are appreciated, thanks! :+1: