Skip to content

Commit abd0989

Browse files
committed
Update contribution guidelines
1 parent 6675e38 commit abd0989

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Before creating a PR, run through this checklist and mark each as complete.
66

77
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/CONTRIBUTING.md) document
88
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works
9-
- [ ] I have checked that all Molecule tests pass after adding my changes
9+
- [ ] I have checked that any relevant Molecule tests pass after adding my changes
1010
- [ ] I have updated any relevant documentation (`defaults/main.yml`, `README.md` and `CHANGELOG.md`)

CONTRIBUTING.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,18 @@ Don't know how something works? Curious if the role can achieve your desired fun
2222

2323
## Getting Started
2424

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.
2626

2727
### Project Structure
2828

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.
3030
* 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/).
3637

3738
## Contributing
3839

@@ -46,8 +47,8 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
4647

4748
### Open a Pull Request
4849

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).
5152

5253
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.
5354

@@ -56,7 +57,7 @@ Note: if you’d like to implement a new feature, please consider creating a fea
5657
### Ansible Guidelines
5758

5859
* 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).
6061
* Follow these guides on some good practices for Ansible:
6162
* <https://www.ansible.com/blog/ansible-best-practices-essentials>
6263
* <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html>

0 commit comments

Comments
 (0)