Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 2.76 KB
Raw

Contributing to tf-plan-pr-comment

First off, thank you for considering contributing to tf-plan-pr-comment. It's people like you that make tf-plan-pr-comment such a great tool.

Code of Conduct

This project and everyone participating in it is governed by the tf-plan-pr-comment Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with your suggestion.

Your First Code Contribution

  • Fork the repo.
  • Create a new branch (git checkout -b improve-feature)
  • Make the appropriate changes in the files.
  • Add changes to reflect the changes made.
  • Commit your changes (git commit -am 'Improve feature')
  • Push to the branch (git push origin improve-feature)
  • Create a Pull Request.

Pull Requests

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or fewer

Terraform Styleguide

  • Use Terraform fmt for formatting.
  • Use meaningful names for resources and variables.
  • Comment your code where necessary.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

Label name Description
bug Indicates a confirmed bug.
enhancement Indicates a feature request.
documentation Indicates a need for documentation.

License

By contributing, you agree that your contributions will be licensed under its MIT License.