Contribution guidelines

March 23, 2021 ยท View on GitHub

How to contribute to project?

All contributions to this project are welcome. To propose changes, we encourage contributors to:

  1. Fork this project on GitHub
  2. Create a new branch, and
  3. Propose their changes by opening a new pull request.

If you're looking for somewhere to start, check out the issues labeled "Good first issue" or Community.

Issue and PR templates

We encourage contributors to format pull request titles following the Conventional Commit Specification.

Having problems?

Have you encountered an error? A critical step in troubleshooting is being able to reproduce the problem. Instructions to publicly reproduce errors using GitHub Actions can be found in our guide to reproduce errors.

Code template

Coding style

"Sticking to a single consistent and documented coding style for this project is important to ensure that code reviewers dedicate their attention to the functionality of the validation, as opposed to disagreements about the coding style (and avoid bike-shedding)." This project uses the Google Java Style. IDE plugins to automatically format your code in this style are here.

How do I add a new validation rule?

The "Adding new rules" documentation includes instructions for adding new validation rules to the validator.

How to run tests locally

This project includes unit and end-to-end tests in order to:

  1. Verify the implementation behaves as expected in tests as well as on real data
  2. Make sure any new code does not break existing code

Run the following command at the root of the project to run Java tests:

$ ./gradlew test

Locally run GitHub Actions

We use GitHub Actions to build the project and test on datasets. You can run these tools locally by following our end-to-end testing guide