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 Type" and "Commit Summary" with an optional "Commit description".
- Commit Type: Use the proper commit type for the changes as per conventional commit types.
- Commit Summary: Always use the imperative present tense (Write your commit messages as if you're giving a command or describing what the commit does, not what you did). 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 -
docs: update readme file
feat: add application dockerfile
Format: [Commit Type] Short Summary
Ex: Suppose, You added some functionality. So, the title could be -
[feat] 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 bash scripts in the repository must be linted or formatted using shellcheck to maintain a standard of quality.
- On the web, Paste a shell script on https://www.shellcheck.net for instant feedback. ShellCheck.net is always synchronized to the latest git commit, and is the easiest way to give ShellCheck a go.
- From your terminal, Run shellcheck yourscript in your terminal for instant output,
By contributing, you agree that your contributions will be licensed under its MIT License.