|
| 1 | +# Contribution |
| 2 | + |
| 3 | +This document provides guidelines for contributing to the project. |
| 4 | + |
| 5 | +## Pull Request |
| 6 | + |
| 7 | +Pull requests are the best way to propose changes to the codebase (we use ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)). We actively welcome your pull requests: |
| 8 | + |
| 9 | +1. Fork the repository to your own Github account. |
| 10 | +2. Clone the project to your machine. |
| 11 | +3. Create a branch locally with a succinct but descriptive name. |
| 12 | +4. Commit changes to the branch following any formatting and testing guidelines specific to this repo. |
| 13 | +5. Push changes to your forked repository. |
| 14 | +6. Open a Pull Request in our repository. |
| 15 | + |
| 16 | +## Guidelines |
| 17 | + |
| 18 | +### Commit Message Guidelines |
| 19 | + |
| 20 | +Use the combination of "Commit Type" and "Commit Summary" with an optional "Commit description". |
| 21 | + |
| 22 | +- Commit Type: Use the proper commit type for the changes as per [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) types. |
| 23 | +- 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. |
| 24 | + |
| 25 | +``` |
| 26 | +Ex: Suppose, You updated a file. So, the commit message could be - |
| 27 | + docs: update readme file |
| 28 | + feat: add application dockerfile |
| 29 | +``` |
| 30 | + |
| 31 | +### PR Guidelines |
| 32 | + |
| 33 | +Format: [Commit Type] Short Summary |
| 34 | + |
| 35 | +``` |
| 36 | +Ex: Suppose, You added some functionality. So, the title could be - |
| 37 | + [feat] added function to read input from user |
| 38 | +``` |
| 39 | + |
| 40 | +### Coding Guidelines |
| 41 | + |
| 42 | +- Try to put comments in your code, where required. |
| 43 | +- Try to follow DRY (Don't Repeat Yourself) principle. |
| 44 | +- Follow the style guide to write terraform code recommended by terraform. |
| 45 | + |
| 46 | +## Report Bugs |
| 47 | + |
| 48 | +We use GitHub issues to track bugs. Report a bug by opening a new issue. |
| 49 | + |
| 50 | +## Linting and Formatting |
| 51 | + |
| 52 | +All of the bash scripts in the repository must be linted or formatted using `shellcheck` to maintain a standard of quality. |
| 53 | + |
| 54 | +- 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. |
| 55 | +- From your terminal, Run shellcheck yourscript in your terminal for instant output, |
| 56 | + |
| 57 | +## License |
| 58 | + |
| 59 | +By contributing, you agree that your contributions will be licensed under its [MIT License](LICENSE). |
0 commit comments