Skip to content

contributing.md

Latest commit

 

History

History
67 lines (48 loc) · 2.16 KB

contributing.md

File metadata and controls

67 lines (48 loc) · 2.16 KB

Contributing to GitLab Groups Terraform Module

Thank you for your interest in contributing to the GitLab Groups Terraform module! We welcome contributions that help improve the module's functionality, documentation, and examples.

Getting Started

Before making changes, please:

  1. Open an issue to discuss your proposed changes
  2. Fork the repository and create a feature branch
  3. Ensure you have Terraform >= 1.3.0 installed
  4. Have access to a GitLab instance for testing

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/terraform-gitlab-groups
cd tf-gitlab-groups

# Create a feature branch
git checkout -b feat/your-feature-name

# Test the module
cd examples
terraform init
terraform plan

Pull Request Process

  1. Update Documentation: Ensure README.md reflects any changes to variables, outputs, or usage examples
  2. Test Changes: Verify your changes work with both basic and complex group configurations
  3. Update Examples: Add or modify examples in the examples/ directory if relevant
  4. Version Updates: Update CHANGELOG.md with your changes
  5. Run Validation: Ensure terraform validate and terraform fmt pass

Contribution Checklist

  • Semantic commit messages (see below)
  • Documentation updated for any variable/output changes
  • Examples updated if functionality changes
  • Terraform validation passes (terraform validate)
  • Code formatting applied (terraform fmt)
  • GitLab group features tested against live GitLab instance

Semantic Commit Messages

Use conventional commit format:

  • feat: - New features or GitLab group capabilities
  • fix: - Bug fixes
  • docs: - Documentation and example updates
  • refactor: - Code restructuring without feature changes
  • test: - Testing improvements
  • chore: - Maintenance tasks

Testing Guidelines

  • Test against GitLab CE/EE (specify which version)
  • Verify nested group structures work correctly
  • Test security features (2FA, IP restrictions, etc.)
  • Ensure examples in examples/ directory are functional

Questions?

Open an issue for discussion or reach out to the maintainers. We appreciate your contributions!