CONTRIBUTING.md

Contributing

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

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

1. Fork it
2. improve it
3. submit a pull request

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

• Rules
• Green tests
• Standard code
• Keeping your fork up-to-date

Rules

Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.

• You MUST follow the PSR-1 and PSR-2 (see Rules).
• You MUST run the test suite (see Green tests).
• You MUST write (or update) unit tests.
• You SHOULD write documentation.

Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request (see also how to keep your fork up-to-date).

One may ask you to squash your commits too. This is used to "clean" your Pull Request before merging it (we don't want commits such as fix tests, fix 2, fix 3, etc.).

Also, while creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it.

Your work will then be reviewed as soon as possible (suggestions about some changes, improvements or alternatives may be given).

Green tests

Run the tests using the following script:

vendor/bin/simple-phpunit

or the alias:

composer test

Standard code

Use PHP CS fixer to make your code compliant with composer-changelogs's coding standards:

vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff

or the alias:

composer fix-cs

Keeping your fork up-to-date

To keep your fork up-to-date, you should track the upstream (original) one using the following command:

git remote add upstream https://github.com/pyrech/composer-changelogs.git

Then get the upstream changes:

git checkout main
git pull --rebase origin main
git pull --rebase upstream main
git checkout <your-branch>
git rebase main

Finally, publish your changes:

git push -f origin <your-branch>

Your pull request will be automatically updated.

Thank you!