Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 2.23 KB
Raw

Contributions Are Welcome!

COURAT is an open source project. Contributions made by the community are welcome. Please don't hesitate, send us your ideas, code reviews, pull requests and feature requests to help us improve this project.

Quick Guide

  • Fork the repo.
  • Checkout the branch you want to make changes on:
    • If you are fixing a bug or typo, improving tests or for any small tweak: the lowest branch where the changes can be applied. Once your Pull Request is accepted, the changes will get merged up to highest branches.
  • Install dependencies: composer install.
  • Create a new branch, e.g. feature-foo or bugfix-bar.
  • Make changes.
  • If you are adding functionality or fixing a bug - it is better to add a test!
  • Check if it tests pass: ./vendor/bin/phpunit.
  • Fix project itself: php ./vendor/bin/php-cs-fixer fix.

Opening a Pull Request

You can do some things to increase the chance that your Pull Request is accepted the first time:

  • Submit one Pull Request per fix or feature.
  • If your changes are not up to date, rebase your branch onto the parent branch.
  • Follow the conventions used in the project.
  • Remember about tests and documentation.
  • Don't bump version.

Project's Standards

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.