Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 1.59 KB
Raw

Contributing to Transcriptase

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

All code changes happen through pull requests

Pull requests are the best way to propose changes to the codebase and we use the Github Flow.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Report bugs using Github Issues]

We use GitHub issues to track public bugs. Report a bug by opening a new issue here.

Linting

The CI build will fail on lint issues. To format and run locally execute make lint.

Helpful tip if using an IDE like intelij you can enable file watchers and auto format terraform files.

Generating terraform docs and table of content in README.md

Prerequisites

  • terraform-docs - for OSX brew install terraform-docs (v0.12+)
  • markdown-toc - npm install --save markdown-toc

If you add or remove any terraform input or outputs or change headings in README.md you will need to regenerate the docs. Note that running the following will automatically update the README.md sections

make README.md