Skip to content

Latest commit

 

History

History
93 lines (57 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

93 lines (57 loc) · 3.94 KB
Raw

Contributing to Federation JVM

The Apollo team welcomes contributions of all kinds, including bug reports, documentation, test cases, bug fixes, and features. There are just a few guidelines you need to follow which are described in detail below.

If you want to discuss the project or just say hi, stop by the Apollo community forums.

Workflow

We love Github issues! Before working on any new features, please open an issue so that we can agree on the direction, and hopefully avoid investing a lot of time on a feature that might need reworking.

Small pull requests for things like typos, bugfixes, etc are always welcome.

Please note that we will not accept pull requests for style changes.

Fork this repo

You should create a fork of this project in your account and work from there. You can create a fork by clicking the fork button in GitHub.

One feature, one branch

Work for each new feature/issue should occur in its own branch. To create a new branch from the command line:

git checkout -b my-new-feature

where "my-new-feature" describes what you're working on.

Verify your changes locally

You can use Gradle to build all the modules from the root directory

./gradlew clean build

NOTE: in order to ensure you use the right version of Gradle we highly recommend to use the provided wrapper scripts

Add tests for any bug fixes or new functionality

Unit Tests

We are using JUnit and jacoco for our main testing libraries. This ensures we have good code coverage and can easily test all cases of schema federation.

To run tests:

./gradlew check

Linting

We are using Spotless to apply Google Java Format for code style checking and linting.

Note: Spotless verification tasks will be run as part of the build whenever it includes check task (e.g. build task will also execute check task). If you want to run linting manually, run the command

./gradlew spotlessCheck

spotlessCheck task will verify whether source code is formatted according to the Google Java Format style rules. In order to automatically apply Google style formatting, run the command

./gradlew spotlessApply

Add documentation for new or updated functionality

Please add appropriate javadocs in the source code and ask the maintainers to update the documentation with any relevant information.

Merging your contribution

Create a new pull request (with appropriate labels) and your code will be reviewed by the maintainers. They will confirm at least the following:

  • Tests run successfully (unit, coverage, integration, style)
  • Contribution policy has been followed
  • Apollo CLA is signed

A maintainer will need to sign off on your pull request before it can be merged.

Releasing

In order to release a new version we need to draft a new release and tag the commit. Releases are following semantic versioning and specify major, minor and patch version.

Once release is published it will trigger corresponding Github Action based on the published release event. Release workflow will then proceed to build and publish all library artifacts to Maven Central.

Release requirements

  • tag should specify newly released library version that is following semantic versioning
  • tag and release name should match
  • release should contain the information about all the change sets that were included in the given release. We are using release-drafter to help automatically collect this information and generate automatic release notes.