Thank you for taking the time to contribute! 🎉 Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
The following is a set of guidelines for contributing to terraform-provider-stackguardian on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a Pull Request.
We use GitHub issues to track bugs at https://github.com/stackguardian/terraform-provider-stackguardian/issues. Please use Bug report issue template.
All contributions to solve GitHub issues tagged with "bug", "enhancement" and "help wanted" are most welcome and greatly appreciated.
The StackGuardian Terraform provider could always use more documentation, whether as part of the docs and example directories, or even on the web in blog posts or news articles.
Please use GitHub Discussions to submit feedback and engage with community StackGuardian/feedback#8.
If you want to contribute code changes with commits, please follow these simple guidelines:
- Open a Pull Request as soon as you start working on a feature, bug, test or hotfix and label it with
work-in-progress
, while it is not ready to be merged. - Write a useful description in the commit messages of a Pull Request.
- Update the CHANGELOG.md file before merging a Pull Request.
If you are a contributor with repository write access, please follow these sensible guidelines:
- Do NOT use
git push --force
on themain
branch. - Do NOT commit to other contributor's branches without their consent.
- Use Pull Requests if you are unsure and to suggest changes to other contributors.