Skip to content

Commit f83aedb

Browse files
committed
docs: test guideline before a pull request
1 parent 2420025 commit f83aedb

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ To suggest a feature or enhancement, please create an issue on GitHub with the l
3131
### Open a Pull Request
3232

3333
- Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
34+
35+
- Unit test: run `make test` for NGINX OSS and `make test-plus` for NGINX Plus
36+
- Integration/Manual test: ensure that your changes work in either your app or the following runtime
37+
- [`nginx-s3-gateway`](https://github.com/nginxinc/nginx-s3-gateway)
38+
- [`nginx-lambda-gateway`](https://github.com/nginx-serverless/nginx-lambda-gateway)
39+
40+
Make sure that you also manually test this library that is integrated with the runtime such as `nginx-s3-gateway` and `nginx-lambda-gateway`.
41+
3442
- Fill in [our pull request template](https://github.com/nginxinc/nginx-aws-signature/blob/main/.github/pull_request_template.md).
3543

3644
Note: if you'd like to implement a new feature, please consider creating a [feature request issue](https://github.com/nginxinc/nginx-aws-signature/blob/main/.github/feature_request_template.md) first to start a discussion about the feature.

0 commit comments

Comments
 (0)