Skip to content
This repository has been archived by the owner on May 24, 2021. It is now read-only.

Latest commit

 

History

History
40 lines (28 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.18 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project. All contributions are welcome! We greatly appreciate the following:

  • Reporting bugs
  • Fixing bugs
  • Implementing new features
  • Writing and/or updating documentation
  • Writing tests

Set-up

First, clone this repository and enter it:

$ git clone git@github.com:thinkingmachines/tiffany.git
$ cd tiffany

Then, get the dependencies and build te project

$ go get
$ go build .

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.