ansible-nas/CONTRIBUTING.md

# Contributing

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

## Development Environment

* Development of Ansible-NAS is carried out in [JetBrains PyCharm](https://www.jetbrains.com/?from=Ansible-NAS) on Linux - you'll get some nice recommended extensions and task setups if you do the same.
* You'll need a working Python 3 environment, Docker (to run tests) and [pre-commit](https://pre-commit.com) installed - `pip install -r requirements-dev.txt`.

## General Stuff

* **Restrict pull requests to one piece of functionality or bugfix at a time.**
* Ensure that your changes aren't going to break the GitHub builds. You can run the Pre-commit checks manually (it's not yet configured to run on every commit) using the VSCode task.
* 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.
* Don't mess with line endings, or change spaces for tabs. They're fine how they are.
* Please know that your efforts are appreciated, thanks! :+1:

## Adding a new application

So you want to add a new application. Great!

* Start by looking at the `hello_world` example. Following this structure is the most likely way of getting your PR approved. Leaving out things the `hello_world` example includes (ie docs, tests) will definitely result in your PR being rejected.
* Add to the list of Available Applications in `README.md`
Add contributing docs 2019-01-03 11:35:49 +00:00			`# Contributing`

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

Update contributing docs 2022-09-10 14:28:41 +00:00			`## Development Environment`
Add contributing docs 2019-01-03 11:35:49 +00:00
Doc linting 2023-12-30 22:34:08 +00:00			`* Development of Ansible-NAS is carried out in [JetBrains PyCharm](https://www.jetbrains.com/?from=Ansible-NAS) on Linux - you'll get some nice recommended extensions and task setups if you do the same.`
Update contributing docs 2022-09-10 14:28:41 +00:00			* You'll need a working Python 3 environment, Docker (to run tests) and [pre-commit](https://pre-commit.com) installed - `pip install -r requirements-dev.txt`.
Update contribution guidelines 2020-01-05 09:14:42 +00:00
Update contributing docs 2022-09-10 14:28:41 +00:00			`## General Stuff`
Update contribution guidelines 2020-01-05 09:14:42 +00:00
Update contributing docs 2022-09-10 14:28:41 +00:00			`* Restrict pull requests to one piece of functionality or bugfix at a time.`
			`* Ensure that your changes aren't going to break the GitHub builds. You can run the Pre-commit checks manually (it's not yet configured to run on every commit) using the VSCode task.`
			`* 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.`
			`* Don't mess with line endings, or change spaces for tabs. They're fine how they are.`
Update contribution guidelines 2020-01-05 09:14:42 +00:00			`* Please know that your efforts are appreciated, thanks! :+1:`

Update contributing docs 2022-09-10 14:28:41 +00:00			`## Adding a new application`
Update contribution guidelines 2020-01-05 09:14:42 +00:00
Update contributing docs 2022-09-10 14:28:41 +00:00			`So you want to add a new application. Great!`

			* Start by looking at the `hello_world` example. Following this structure is the most likely way of getting your PR approved. Leaving out things the `hello_world` example includes (ie docs, tests) will definitely result in your PR being rejected.
			* Add to the list of Available Applications in `README.md`