CONTRIBUTING.md

How to Contribute

We're excited you're interested in contributing to Marquez! We'd love your help, and there are plenty of ways to contribute:

• Fix or report a bug
• Fix or improve documentation
• Pick up a "good first issue", then send a pull request our way

We feel that a welcoming community is important and we ask that you follow the Contributor Covenant Code of Conduct in all interactions with the community.

Development

To run the entire test suite:

$ ./gradlew test

You can also run individual tests using the flag --tests:

$ ./gradlew test --tests marquez.api.resources.DatasetResourceTest
$ ./gradlew test --tests marquez.service.DatasetServiceTest
$ ./gradlew test --tests marquez.db.DatasetDaoTest

Or run tests by category:

$ ./gradlew testUnit         # run only unit tests
$ ./gradlew testIntegration  # run only integration tests
$ ./gradlew testDataAccess   # run only data access tests

We use spotless to format our code. This ensures .java files are formatted to comply with Google Java Style. Make sure your code is formatted before pushing any changes, otherwise CI will fail:

$ ./gradlew spotlessApply

Note: To make formatting code simple, we recommend installing a plugin for your favorite IDE. We also us Lombok. Though note required, you might want to install the plugin as well.

Submitting a Pull Request

1. Fork and clone the repository
2. Make sure all tests pass locally: ./gradlew test
3. Create a new branch: git checkout -b my-cool-new-branch
4. Make change on your cool new branch
5. Write a test for your change
6. Make sure .java files are formatted: ./gradlew spotlessJavaCheck
7. Push change to your fork and submit a pull request
8. Add the "review" label to your pull request
9. Work with project maintainers to get your change reviewed and merged into the master branch
10. Delete your branch

To ensure your pull request is accepted, follow these guidelines:

• All changes should be accompanied by tests
• Do your best to have a well-formed commit message for your change
• Keep diffs small and self-contained
• If your change fixes a bug, please link the issue in your pull request description

Resources

• How to Contribute to Open Source
• Using the Fork-and-Branch Git Workflow
• Keep a Changelog