Contributing

Thank you for your interest in contributing to C3 CloudFront Cache Controller!

Development Environment Setup

Prerequisites

• PHP: 7.4 or higher
• Node.js: 20 or higher
• Git: For version control

Setup Steps

1. Clone the repository:

   git clone https://github.com/amimoto-ami/c3-cloudfront-clear-cache.git
   cd c3-cloudfront-clear-cache

2. Install Node.js dependencies:

   npm install

3. Start development environment with wp-env:

   npm run dev

4. Install PHP dependencies

   npm run composer:install

Development Workflow

Branch Strategy

• master - Production branch
• develop - Development branch
• feature/* - Feature branches
• bugfix/* - Bug fix branches

Creating a Feature Branch

git checkout develop
git pull origin develop
git checkout -b feature/your-feature-name

# Make changes and commit
git add .
git commit -m "feat: add your feature description"

# Create pull request
git push origin feature/your-feature-name

Testing

Running Tests

# Run all tests
npm run test

# Run specific test suites
wp-env run tests composer run test:unit
wp-env run tests composer run test:integration

Code Quality

Code Style Checks

# PHP CodeSniffer
wp-env run tests composer run phpcs

# Auto-fix code style
wp-env run tests composer run phpcbf

Pull Requests

Pre-submission Checklist

• [ ] All tests pass
• [ ] Code follows style guidelines
• [ ] Documentation updated (if needed)

Pull Request Template

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
- [ ] Unit tests added/updated
- [ ] Manual testing completed

Resources

• WordPress Plugin Developer Handbook
• WordPress Coding Standards
• AWS CloudFront API Documentation

Thank you for contributing!