Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 2.25 KB

Contributing

First of all, thank you for contributing, you are awesome!

Everybody should be able to help. Here's how you can do it

Here's some tips to make you the best contributor ever

Bug reports

Please search existing issues first to make sure this is not a duplicate. Every issue report has a cost for the developers required to field it; be respectful of others' time and ensure your report isn't spurious prior to submission. Try to be as detailed as possible in your problem description to help us fix the bug. Please adhere to sound bug reporting principles.

Feature requests

If you wish to propose a feature, please submit an issue. Try to explain your use case as fully as possible to help us understand why you think the feature should be added.

Creating a pull request

First fork the repository on GitHub.

Then clone your fork:

git clone [email protected]:darkwood-com/flow.git
git checkout -b bug-or-feature-description

And install the dependencies:

composer install

Write your code and add tests. Then run the tests:

make test

Commit your changes and push them to GitHub:

git commit -m ":sparkles: Introduce awesome new feature"
git push -u origin bug-or-feature-description

Then create a pull request on GitHub.

If you need to make some changes, commit and push them as you like. When asked to squash your commits, do so as follows:

git rebase -i
git push origin bug-or-feature-description -f

Coding standard

This project follows the Symfony coding style. Please make sure your pull requests adhere to this standard.

To fix, execute this command after download PHP CS Fixer:

make php-cs-fixer