Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2024-12-26 03:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update contribution guidelines

Browse source
This commit is contained in:
David Stephens 2020-01-05 09:14:42 +00:00
parent dcb536be80
commit 1454fed093
2 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/contributing.md → CONTRIBUTING.md
View file

@ -12,3 +12,14 @@ If you're adding a new application:
* Ensure that the new application is disabled by default. * Ensure that the new application is disabled by default.
* Add a documentation page to `docs/applications/` - use an existing application as an example. * 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. * 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! :+1:
# Development Environment
* Development of Ansible-NAS is carried out in [Visual Studio Code](https://code.visualstudio.com/) - you'll get some nice
recommended extensions and task setups if you do the same.

14
README.md
View file

@ -143,20 +143,8 @@ Getting help is easy! You can:
## Contributing ## Contributing
Contributions are welcome, please feel free to raise a PR! Contributions are always welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) first.
* 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. Note that Ansible-NAS
requires Vagrant version 2.2.2 or later, so for stock Ubuntu 18.04.2, you will
have to download and install the newest version from
https://www.vagrantup.com/downloads.html.
* Run `ansible-lint` against the playbook before committing. (There is a VSCode
task set up to run the right command for you)
* Please know that your efforts are appreciated, thanks! :+1:
Development of Ansible-NAS is carried out in [Visual Studio Code](https://code.visualstudio.com/) - you'll get some nice
recommended extensions and task setups if you do the same.
## Support ## Support