Contributing to Jankx

Thank you for your interest in contributing to Jankx! This guide will help you get started.

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on what's best for the community

How Can I Contribute?

Reporting Bugs

Before creating a bug report:

  1. Check if the issue already exists
  2. Use the latest version to verify
  3. Collect relevant information

Pull Requests

  1. Fork the repository
  2. Create a branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Run tests: ./vendor/bin/phpunit
  5. Commit: git commit -m 'Add amazing feature'
  6. Push and open a PR

Development Setup

git clone https://github.com/YOUR_USERNAME/theme.git
composer install
npm install
./vendor/bin/phpunit

Coding Standards

  • Follow PSR-12 coding standards
  • Use strict typing: declare(strict_types=1);
  • Write docblocks for all methods
  • Maximum line length: 120 characters

Testing

All new features must include tests. Aim for 80%+ coverage.

./vendor/bin/phpunit
./vendor/bin/phpunit --coverage-html coverage/

Commit Message Format

Use conventional commits:

feat(layout): add masonry layout
fix(admin): resolve notice display
docs: update contributing guide

← Back to Documentation