Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 2 KB

Contributing to PHP SVG Optimizer

First off, thank you for taking the time to contribute! 🎉👍

We welcome contributions, bug reports, and feature suggestions. Open source thrives on collaboration, and we are always eager to work with more contributors!

Code of Conduct

By participating in this project, you agree to uphold our Code of Conduct.

Reporting Bugs

If you encounter a bug, please open an issue. A good bug report should include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual results
  • Any relevant logs or screenshots

Suggesting Enhancements

We love hearing new ideas! If you have a suggestion for improving the library, please open an issue with your proposal.

Your First Code Contribution

If you’re unsure where to start, look for issues tagged with 'good first issue'. These issues are small, manageable tasks that are great for newcomers to the project.

Pull Requests

To submit a pull request:

  1. Fork the repository and clone your fork.
  2. Create a new branch for your feature, change, or fix.
  3. Commit your changes in logical chunks. Follow the commit message guidelines.
  4. Push your branch to your fork.
  5. Open a Pull Request with a clear title and description on GitHub.

Setting Up Your Environment

  1. Clone the repository:

    git clone git@github.com:MathiasReker/php-svg-optimizer.git && cd php-svg-optimizer

  2. Install the dependencies:

    composer install

  3. Run the tests:

     composer test

Please ensure that all tests pass before submitting your pull request.

Thank you for contributing! 🎉