This document provides guidelines for contributing to the project.
Pull requests are the best way to propose changes to the codebase (we use "fork-and-pull" Git workflow). We actively welcome your pull requests:
- Fork the repository to your own Github account.
- Clone the project to your machine.
- Create a branch locally with a succinct but descriptive name.
- Commit changes to the branch following any formatting and testing guidelines specific to this repo.
- Push changes to your forked repository.
- Open a Pull Request in our repository.
Use the combination of "Commit context" and "Commit summary" with an optional "Commit description".
- Commit context: Use 1-3 prefixes to describe the context of your commit Like add/update/remove.
- Commit summary: Always use the imperative present tense. Don’t capitalize the first letter of the commit message. Don’t use a period at the end of your text.
Ex: Suppose, You updated a file. So, the commit message could be -
[update] readme file updated
Format: [Branch Name][Action] Comment
Ex: Suppose, You added some functionality. So, the title could be -
[master][add] added function to read input from user
- Try to put comments in your code, where required.
- Try to follow DRY (Don't Repeat Yourself) principle.
- Follow the style guide to write terraform code recommended by terraform.
We use GitHub issues to track bugs. Report a bug by opening a new issue.
All of the terraform configuration files in the repository must be linted or formatted using terraform fmt to maintain a standard of quality.
By contributing, you agree that your contributions will be licensed under its MIT License.