Skip to content

Commit

Permalink
- build(ci): Remove revapiAcceptAllBreaks on revapi (awslabs#424)
Browse files Browse the repository at this point in the history
- chore(README): Update to latest version (awslabs#423)
- Update CONTRIBUTING.md (awslabs#421)
  • Loading branch information
stefanofornari committed Mar 25, 2024
1 parent 8fa0c1b commit 1823450
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 11 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,3 @@ target

# MacOS
.DS_Store

# Palantir Revapi
.palantir
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ For example:
<dependency>
<groupId>software.amazon.nio.s3</groupId>
<artifactId>aws-java-nio-spi-for-s3</artifactId>
<version>2.0.0-dev</version>
<version>2.0.0</version>
</dependency>
```

`build.gradle(.kts)`
```groovy
implementation("software.amazon.nio.s3:aws-java-nio-spi-for-s3:2.0.0-dev")
implementation("software.amazon.nio.s3:aws-java-nio-spi-for-s3:2.0.0")
```

The library heavily relies on the `crt` client from aws. It uses the [`uber`
Expand All @@ -84,7 +84,7 @@ and wide range of supported platforms.
> If **size** is an **issue**, you can **exclude** the `crt` dependency from the library and import the [specific `crt` library](https://github.com/awslabs/aws-crt-java?tab=readme-ov-file#platform-specific-jars)
> for your platform. For example:
> ```
> implementation("software.amazon.nio.s3:aws-java-nio-spi-for-s3:2.0.0-dev") {
> implementation("software.amazon.nio.s3:aws-java-nio-spi-for-s3:2.0.0") {
> exclude group: 'software.amazon.awssdk.crt', module: 'aws-crt'
> }
> implementation 'software.amazon.awssdk.crt:aws-crt:0.29.11:linux-x86_64'
Expand Down

0 comments on commit 1823450

Please sign in to comment.