Skip to content

Commit

Permalink
Remove API binary compatibility info
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszkalnik committed Dec 24, 2021
1 parent 04cdcb5 commit 202ced5
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
Expand Up @@ -156,11 +156,9 @@ Please, follow the link to [create an issue](https://github.com/arrow-kt/arrow/i

The easiest way to contribute to Arrow is to create a branch from a fork, and then create a PR on Github from your branch.

Arrow is a large project that uses several tools to verify that the code is formatted consistently, and that we don't break downstream projects that rely on Arrow's API across versions.
Arrow is a large project that uses tools to ensure that the code is formatted consistently. We use [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) with [KtFmt](https://github.com/facebookincubator/ktfmt). It needs to run before you commit and push your code to Github.

For code formatting we use [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) with [KtFmt](https://github.com/facebookincubator/ktfmt) and for API binary compatibility we use [Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator). They need to run before you commit and push your code to Github.

If you've included those changes for binary compatibility and formatted the code correctly it's time to open your PR and get your contribution into Arrow. Thanks ahead of time for your effort and contributions 🙏
If you've formatted the code correctly it's time to open your PR and get your contribution into Arrow. Thanks ahead of time for your effort and contributions 🙏

#### Requirements to change an existing feature

Expand All @@ -169,7 +167,6 @@ If you want to propose a fix, rename, move etc., please execute these required t
* Required tasks:
```bash
./gradlew spotlessApply # Format code
./gradlew apiDump # Generate .api files for binary compatibility review
./gradlew build
./gradlew buildDoc
```
Expand All @@ -187,7 +184,6 @@ When creating the pull request, please execute these required tasks and make sur
* Required tasks:
```bash
./gradlew spotlessApply # Format code
./gradlew apiDump # Generate .api files for binary compatibility review
./gradlew build
./gradlew buildDoc
```
Expand Down

0 comments on commit 202ced5

Please sign in to comment.