Contributions are always welcome; however, please read this document in its entirety before submitting a Pull Request or Reporting a bug.
- Reporting a bug
- Creating an issue
- Feature requests
- Opening a pull request
- Code of Conduct
- License
- Contributor license agreement
Think you've found a bug? Let us know!
Your issue must follow these guidelines for it to be considered:
- Check you’re on the latest version, we may have already fixed your bug!
- Search our issue tracker for your problem, someone may have already reported it
- Clear, reproducible steps to encounter the bug
- Current system information
- Apply the
bug
label - Apply (to the best of your ability) the appropriate
component/
label- If you are uncertain simply use
component/cli
- If you are uncertain simply use
Manifold CLI is ever-evolving, and that's thanks to user feedback. If you have an idea for a feature, let us know!
- How the tool operates today.
- Why current functionality is problematic.
- Use cases for the new functionality
- A detailed proposal (or pull request) that demonstrates how you feel the problem could be solved.
- Apply the
discussion/feature
label - Apply (to the best of your ability) the appropriate
component/
label- If you are uncertain simply use
component/cli
- If you are uncertain simply use
To contribute, fork terraform-provider-manifold
, commit your changes, and open a pull request.
Your request will be reviewed once the appropriate labels have been added. You may be asked to make changes to your submission during the review process.
- Run the tests using
make test
- Review the manual QA guide (until our test coverage improves)
- Test your change thoroughly
- Supply examples of command behaviour (command output, daemon logs, etc)
- Explain why your particular changes were made the way they are
- Reference the issue your request closes in the body of the PR with
Closes #
- Apply the
meta/in-review
label once your code is ready for review - If you are opening before it is finished, please use
meta/in-progress
- Apply (to the best of your ability) the appropriate
component/
label- If you are uncertain simply use
component/cli
- If you are uncertain simply use
Go uses gofmt
to automatically format your code, it's best to integrate this into your editor.
Check your code's formatting using make fmtcheck
.
All community members are expected to adhere to our code of conduct.
Manifold's terraform-provider-manifold is released under the BSD 3-Clause License.
For legal purposes all contributors must sign a contributor license agreement, either for an individual or corporation, before a pull request can be accepted.
You will be prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time.