Contribution process #

This page explains how you can contribute code and documentation to the magic-modules repository.

Before you begin #

1. Familiarize yourself with GitHub flow
2. Fork the Magic Modules repository into your GitHub account
3. Set up your development environment
4. Check whether the feature you want to work on has already been requested in the issue tracker.
   • If there’s an issue and it already has a dedicated assignee, this indicates that someone might have already started to work on a solution. Otherwise, you’re welcome to work on the issue.

Contribute code #

1. Set up your development environment
2. Create a new branch for your change
3. Make the code change. For example:
   • Add or modify a resource
   • Add resource tests
   • Add a datasource
   • Promote to GA
   • Make a breaking change
4. Generate the providers that include your change.
5. Run provider tests locally that are relevant to the change you made
6. Create a pull request (PR)
7. Make changes in response to code review

After your change is merged #

After your change is merged, it can take a week or longer to be released to customers.