Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 3.12 KB
Raw

Contributing

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to JPT. All the changes are welcome. Please help us to improve code, examples and documentation.

Testing

This module's tests require an access to AWS. The credentials should be provided via setting the environmental variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

To run this module default test suite execute ./gradlew build. To run the full test suite including acceptance tests execute ./gradlew testAcceptance.

Developer’s Environment

You can build and run JPT on MacOS, Windows or Linux. You'll need JDK 8-11 to build the project and AWS credentials to test the change.

Submitting changes

Pull requests, issues and comments are welcome. For pull requests:

  • Create your own fork of the repository and raise a pull request targeting master branch in the main repository
  • Enable Bitbucket pipelines, it is important that you do it via Settings menu and not Pipelines menu otherwise Bitbucket will create an empty commit polluting Git history of your fork
  • Configure Bitbucket pipelines by providing AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables with your AWS credentials. This can be done in your repository settings in Pipelines section
  • Add tests for new features and bug fixes
  • Follow the existing style
  • Separate unrelated changes into multiple pull requests

See the existing issues for things to start contributing.

For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change.

All the pull requests and other changes will be accepted and merged by Atlassians.

Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).

Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.

Style Guide / Coding conventions

Git commit messages

(incomplete)

Releasing

Versioning, releasing and distribution are managed by the gradle-release plugin.