Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

61 lines (45 loc) · 2.06 KB

Contributing to Flightdeck

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code ( no patch is too small : fix typos, add comments, etc. )
  • by refactoring code
  • by closing issues
  • by reviewing patches

Submitting an Issue

  • We use the GitHub issue tracker to track bugs and features.
  • Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
  • When submitting a bug report, please include a as much detail as possible to reproduce the bug, including your region, parameters, etc.

Cleaning up issues

  • Issues that have no response from the submitter will be closed after 30 days.
  • Issues will be closed once they're assumed to be fixed or answered. If the maintainer is wrong, it can be opened again.
  • If your issue is closed by mistake, please understand and explain the issue. We will happily reopen the issue.

Submitting a Pull Request

  1. Fork the official repository.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add, commit, and push your changes.
  5. Submit a pull request.

Setting up

  1. You will need Terraform, tflint, and terraform-docs. You can install these using asdf.
  2. Run make to make sure everything is set up.

Testing your changes

  1. Edit the module file.
  2. Run make to validate your changes.