Contribution Guidelines

How to contribute to Org Kickstart

We welcome contributions to both the Terraform module and this documentation site. All submissions require review via GitHub pull request.

Contributing to the Module

  1. Fork the org-kickstart repo on GitHub
  2. Create a feature branch
  3. Make your changes and test them against a real AWS Organization (see the CLAUDE.md for testing guidance)
  4. Send a pull request with a clear description of the change and why it’s needed

Testing

When modifying the module:

  • Use make env=your-org tf-plan extensively before applying
  • Test in a non-production organization first
  • Use targeted applies for risky changes: terraform apply -var-file="your-org.tfvars" -target <resource>
  • Verify SCPs don’t lock out root or prevent remediation

Contributing to the Docs

The documentation source lives in the org-kickstart-site/ directory alongside the module.

Running the Site Locally

Requirements:

  • Hugo extended >= 0.155.0
  • Node.js (for PostCSS/SCSS processing)
cd org-kickstart-site
make npm        # install Node dependencies (first time only)
make test       # starts dev server at http://localhost:1319/

Use make test-drafts to also render draft and future-dated content.

Editing Pages

  1. Fork the org-kickstart-site repo
  2. Edit files under org-kickstart-site/content/en/
  3. Preview locally with make test
  4. Submit a pull request

You can also click Edit this page in the top right of any documentation page to jump directly to the source file on GitHub.

Creating an Issue

Found a bug or want to request a feature? Open an issue on GitHub.

Useful Resources