Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 993 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 993 Bytes

Contributing

When contributing to this repository, please first discuss with the owners of this repository the change you wish to make or bug you want to report via issue before making a change.

Coding conventions

We are using Scalafmt for style checking and formatting. You can set it up for yourself using provided config

Contributing process

  1. Fork the project and make a new branch
  2. Implement your change
  3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  4. Make sure you are up to date with upstream master
  5. Create a Pull Request to upstream master and link it to a corresponding issue
  6. Merge the Pull Request in, using "Squash and merge" strategy, once you have the sign-off of another developer, or if you do not have permission to do that, you may request the reviewer to merge it for you