You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,17 +22,18 @@ Don't know how something works? Curious if the role can achieve your desired fun
22
22
23
23
## Getting Started
24
24
25
-
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role.
25
+
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX App Protect Ansible role.
26
26
27
27
### Project Structure
28
28
29
-
* The NGINX Ansible role is written in `yaml` and supports NGINX App Protect.
29
+
* The NGINX App Protect Ansible role is written in `yaml` and supports NGINX App Protect.
30
30
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
31
-
* The main code is found in `tasks/`
32
-
* The main variables can be found in `defaults/main.yml`
33
-
* Configuration templates for NGINX Plus and NGINX App Protect can be found in `templates/`
34
-
*[Molecule](https://molecule.readthedocs.io/) tests can be found in `molecule/`.
35
-
* CI/CD is done via Travis using `.travis.yml` deployment yaml files
31
+
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/tasks/).
32
+
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/defaults/main/).
33
+
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/vars/main.yml).
34
+
* Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/templates/).
35
+
*[Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/molecule/).
36
+
* CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/.github/workflows/).
36
37
37
38
## Contributing
38
39
@@ -46,8 +47,8 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
46
47
47
48
### Open a Pull Request
48
49
49
-
* Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review
50
-
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/.github/PULL_REQUEST_TEMPLATE.md)
50
+
* Fork the repo, create a branch, implement your changes, add any relevant Molecule tests, submit a PR when your changes are **tested** (using Molecule) and ready for review.
51
+
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/.github/pull_request_template.md).
51
52
52
53
Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
53
54
@@ -56,7 +57,7 @@ Note: if you’d like to implement a new feature, please consider creating a fea
56
57
### Ansible Guidelines
57
58
58
59
* Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues.
59
-
* Run `molecule test --all` on your code before you submit a PR to catch any potential issues.
60
+
* Run `molecule test` on your code before you submit a PR to catch any potential issues. If you are testing a specific molecule scenario, run `molecule test -s <scenario>`. You will need to procure an NGINX App Protect license (check out the [NGINX Plus developer license FAQ](https://www.nginx.com/developer-license-faqs/) to find out how to request one).
60
61
* Follow these guides on some good practices for Ansible:
0 commit comments