Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (37 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.3 KB

Contributing to BakeKit

Thank you for your interest in contributing to BakeKit!

I'm currently the sole developer, and BakeKit has grown from the needs of my custom Shop plugin. I would greatly appreciate any help — whether it's fixing bugs, writing tests, or improving documentation.

How to Set Up

  1. Clone the repository: 
    git clone https://github.com/bakewizard/BakeKit.git
cd BakeKit
  2. Install dependencies: 
    curl -sS https://getcomposer.org/installer | php -- --install-dir=bin
bin/composer.phar install
bin/cake install

Branching

  • Work from the develop branch
  • Use feature branches: feature/your-thing or bugfix/your-thing

Coding Standards

  • Follow CakePHP coding standards
  • Use PSR-12 formatting
  • Write clean, readable code with helpful comments

Submitting a Pull Request

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Write a clear commit message
  5. Submit a pull request to develop
  6. Include a description of what and why

Reporting Issues

If you found a bug or have a feature idea, please open an issue. Include:

  • Clear title
  • Description of the problem or request
  • Steps to reproduce (if a bug)

Thanks again for helping make BakeKit better!
– @bakewizard