From 6655af08e05fff671f33c0312a3c42676d38420e Mon Sep 17 00:00:00 2001 From: guicamest <283778+guicamest@users.noreply.github.com> Date: Wed, 20 Mar 2024 02:30:31 +0100 Subject: [PATCH] Update CONTRIBUTING.md (#421) --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c3b4680..d22220b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,8 +11,8 @@ information to effectively respond to your bug report or contribution. We welcome you to use the GitHub issue tracker to report bugs or suggest features. -When filing an issue, please check [existing open](https://github.com/aws/amazon-genomics-cli/issues), -or [recently closed](https://github.com/aws/amazon-genomics-cli/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), +When filing an issue, please check [existing open](https://github.com/awslabs/aws-java-nio-spi-for-s3/issues), +or [recently closed](https://github.com/awslabs/aws-java-nio-spi-for-s3/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: @@ -39,7 +39,7 @@ To send us a pull request, please: 1. Fork the repository. 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. -3. Use only java 1.8 language features and ensure code will compile with sdk 1.8.0_322 (8.322) or later patch versions +3. Use language features compatible with Java 11 and ensure the code will compile with the latest release of that version 4. Ensure unit tests cover your change and demonstrate expected behavior 5. Ensure unit tests do NOT require AWS credentials or S3 connectivity by using Mocks for any `S3Client` or `S3AsyncClient`. Remember, unit tests test this library and not the functionality of S3. 6. Run `./gradlew check` to ensure local tests pass and test coverage reports are produced. @@ -57,7 +57,7 @@ GitHub provides additional document on [forking a repository](https://help.githu ## Finding contributions to work on Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), -looking at any ['help wanted'](https://github.com/aws/amazon-genomics-cli/labels/help%20wanted) issues is a great place to start. +looking at any ['help wanted'](https://github.com/awslabs/aws-java-nio-spi-for-s3/labels/help%20wanted) issues is a great place to start. ## Code of Conduct @@ -73,7 +73,7 @@ Please do **not** create a public Github issue. ## Licensing -See the [LICENSE](https://github.com/aws/amazon-genomics-cli/blob/main/LICENSE) file for our +See the [LICENSE](https://github.com/awslabs/aws-java-nio-spi-for-s3/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement)