Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (72 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

101 lines (72 loc) · 3.02 KB

Contributing to Laravel Simple Backup

Thank you for considering contributing to Laravel Simple Backup! We appreciate your interest in helping us improve this package.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots and animated GIFs if possible
  • Include your environment details (PHP version, Laravel version, OS, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and expected behavior
  • Explain why this enhancement would be useful

Pull Requests

  • Fill in the required template
  • Follow the PHP styleguides
  • Include appropriate test cases
  • Update documentation as needed
  • End all files with a newline

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/laravel-simple-backup.git
  3. Create a feature branch: git checkout -b feature/your-feature-name
  4. Install dependencies: composer install
  5. Make your changes
  6. Run tests: vendor/bin/phpunit
  7. Commit your changes with descriptive messages
  8. Push to your fork
  9. Create a Pull Request

Styleguides

PHP Code Style

  • Use PSR-12 coding standard
  • Use meaningful variable and function names
  • Add PHPDoc comments for public methods
  • Keep methods focused and single-responsibility

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Example:

Add database backup scheduling feature

- Implement scheduled backup command
- Add cron job support
- Update documentation

Documentation

  • Use clear and concise language
  • Include code examples where appropriate
  • Keep README.md up to date
  • Add inline comments for complex logic

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting a PR
  • Aim for good test coverage
  • Use descriptive test names

Run tests with:

vendor/bin/phpunit

Questions?

Feel free to open an issue with the question tag or contact the maintainers.

Thank you for contributing! 🎉