Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

36 lines (28 loc) · 1.83 KB

Contributing Overview

Contributions to our repos are welcomed by any user interested in the improvement of a particular piece of code or functionality. As a starting point, interested users should find existing issues to work on. Users are encouraged to contribute in the forms of:

  1. Reporting a Bug or Feature
  2. Contributing code via Pull Request

Reporting a Bug or Requesting a Feature

  • Before filling out a new request please:
    • Check if there are existing reports (opened or closed)
    • Have all materials prepared to fill out the appropriate Issue Template

Contributing via Pull Request

  • Before filling out a pull Request :
    • Have related issues numbers
    • Not have changed any tags
  1. Pull the latest of Master Branch
  2. Checkout feature branch
  3. Make appropriate commits
  4. Push committed code to remote branch as needed
  5. Before final push please ensure:
    • Run terraform fmt to ensure code is formatted correctly
    • Clean up any commit Messages
    • Run any local tests
  6. Fill Out Pull Request Template.
  7. Request at least 1 approver (GitHub will automatically populate the approvers with code owners as approval from a code owners is required to merge).
  8. Pull Request will be merged if approved, and if all GH actions completed successfully

Code of Conduct

Our project has adopted Contributor Covenant v2.0