|
| 1 | +# Contributing to the Project |
| 2 | + |
| 3 | +We appreciate your interest in contributing to our project! To ensure a smooth and consistent contribution process, please follow these guidelines. |
| 4 | + |
| 5 | +## Pull Request Guidelines |
| 6 | + |
| 7 | +### Conventional Commits |
| 8 | + |
| 9 | +- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your PR titles. This helps us automate versioning and changelog generation. |
| 10 | +- Examples of Conventional Commit messages: |
| 11 | + - `feat: add new feature to module` |
| 12 | + - `fix: resolve issue with deployment script` |
| 13 | + - `docs: update documentation for new feature` |
| 14 | + - `chore: update dependencies` |
| 15 | + |
| 16 | +### Updating Documentation |
| 17 | + |
| 18 | +- Before submitting a PR, make sure to update the Terraform documentation. |
| 19 | +- Run the following command to generate the documentation and update the `README.md` file: |
| 20 | + ```bash |
| 21 | + terraform-docs markdown . --output-file README.md |
| 22 | + ``` |
| 23 | + |
| 24 | +## Development Workflow |
| 25 | + |
| 26 | +1. **Fork the Repository**: Create a fork of the repository to work on your changes. |
| 27 | +2. **Clone Your Fork**: Clone your forked repository to your local machine. |
| 28 | +```bash |
| 29 | +git clone https://github.com/your-username/your-repo.git |
| 30 | +cd your-repo |
| 31 | +``` |
| 32 | + |
| 33 | +3. **Create a Branch**: Create a new branch for your feature or bugfix. |
| 34 | +```bash |
| 35 | +git checkout -b feat/your-feature-name |
| 36 | +``` |
| 37 | + |
| 38 | +4. **Make Changes**: Implement your changes in the new branch. |
| 39 | +5. **Commit Changes**: Commit your changes using a Conventional Commit message. |
| 40 | +```bash |
| 41 | +git add . |
| 42 | +git commit -m "feat: add new feature to module" |
| 43 | +``` |
| 44 | + |
| 45 | +6. **Update Documentation**: Run terraform-docs to update the README.md file. |
| 46 | +```bash |
| 47 | +terraform-docs markdown . --output-file README.md |
| 48 | +``` |
| 49 | + |
| 50 | +7. **Push Changes**: Push your branch to your forked repository. |
| 51 | +```bash |
| 52 | +git push origin feat/your-feature-name |
| 53 | +``` |
| 54 | + |
| 55 | +8. **Open a Pull Request**: Open a PR to the main repository. Make sure your PR title follows the Conventional Commits guidelines. |
| 56 | + |
| 57 | +## Code Review |
| 58 | +Your PR will be reviewed by one of the maintainers. Please be responsive to feedback and be prepared to make adjustments to your code. |
| 59 | +Once approved, your PR will be merged into the main branch. |
| 60 | + |
| 61 | +## Thank You |
| 62 | +Thank you for contributing to our project! Your support and contributions are greatly appreciated. |
0 commit comments