Thank you for considering contributing to this project! We welcome contributions from the community and aim to make it as easy as possible to get involved.
This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
If you encounter a bug, performance issue, or have a question, please check our issue tracker and ensure the issue has not been reported already. If it hasn't, feel free to open a new issue.
- Fork the repository and create your branch from
main. - Write clear and concise code that follows our style guide.
- Test your changes to ensure the module behaves as expected.
- Create a pull request following the template provided.
- Include a clear description of what the PR changes.
- Reference the issue number your PR is related to (if applicable).
- Ensure that your changes follow the Coding Guidelines.
- Wait for reviews and address any feedback.
All pull requests should:
- Be based on the latest
mainbranch. - Include tests for the proposed changes.
- Pass all checks (linting, testing).
- Provide a detailed description of the change and its impact.
To ensure consistency across the codebase, please adhere to the following standards:
-
Code Formatting: You can run the following command to format your code:
terraform fmt
-
Commit Messages: Follow Conventional Commits for commit messages. For example:
fix: resolve navbar alignment issuefeat: add user authentication
Please make sure all tests pass before submitting a PR. If you add new functionality, include corresponding unit/integration tests.
-
Run Tests:
terraform init terraform test -
End-to-End Testing: If applicable, ensure your changes work across various environments by adding E2E tests.
Thank you for contributing!