From 1454fed0937673c4b4dd7a36894a8eeb3e3e13a9 Mon Sep 17 00:00:00 2001 From: David Stephens Date: Sun, 5 Jan 2020 09:14:42 +0000 Subject: [PATCH] Update contribution guidelines --- docs/contributing.md => CONTRIBUTING.md | 13 ++++++++++++- README.md | 14 +------------- 2 files changed, 13 insertions(+), 14 deletions(-) rename docs/contributing.md => CONTRIBUTING.md (60%) diff --git a/docs/contributing.md b/CONTRIBUTING.md similarity index 60% rename from docs/contributing.md rename to CONTRIBUTING.md index 28178e10..13f6d8fb 100644 --- a/docs/contributing.md +++ b/CONTRIBUTING.md @@ -11,4 +11,15 @@ 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. \ No newline at end of file +* 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. \ No newline at end of file diff --git a/README.md b/README.md index 1d1ac31a..053db4e2 100644 --- a/README.md +++ b/README.md @@ -143,20 +143,8 @@ Getting help is easy! You can: ## 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