All contributors are welcome to submit patches but please keep the following in mind:
Please also keep in mind:
- Be patient as not all items will be tested or reviewed immediately by the core team.
- Be receptive and responsive to feedback about your additions or changes. The core team and/or other community members may make suggestions or ask questions about your change. This is part of the review process, and helps everyone to understand what is happening, why it is happening, and potentially optimizes your code.
- Be understanding
If you're looking to contribute but aren't sure where to start, check out the open issues.
This details Pull Requests that we will not be merged.
- New features without accompanying tests or proof of operation
- New features without accompanying usage documentation
The submitted code should be compatible with the following standards
- 2-space indentation style
- First curl brace on the same line as the method
- Closing curl brace on its own aligned newline
- Variable and value assignment does not need to be aligned with assignment operator
- Where possible, avoid HEREDOC in favor of script or templates
Please indicate the results of your tests in a comment along with the pull request. Supplying tests and the method used to run/validate the changes are highly encouraged.
Familiarize yourself with Terraform and be well versed in its interpolations.
Familiarize yourself with GitHub Enterprise and GitHub Developer documentation.
-
Fork the git repository from GitHub:
-
Create a branch for your changes:
$ git checkout -b my_bug_fix -
Make any changes
-
Write tests to support those changes.
-
Run the tests:
-
Assuming the tests pass, open a Pull Request on GitHub and add results
- Do include tests for your contribution
- Do request feedback via GitHub issues or other contact
- Do NOT break existing behavior (unless intentional)
- Do NOT modify the CHANGELOG