Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

83 lines (53 loc) · 2.74 KB
Raw

Contributing to CoopTilleulsForgotPasswordBundle

First of all, thank you for contributing, you're awesome!

To have your code integrated in the CoopTilleulsForgotPasswordBundle project, there is some rules to follow, but don't panic, it's easy!

Reporting bugs

If you happen to find a bug, we kindly request you to report it using GitHub by following these 3 points:

  • Check if the bug is not already reported
  • A clear title to resume the issue
  • A description of the workflow needed to reproduce the bug

NOTE: Don't hesitate giving as much information as you can (OS, PHP version, extensions...)

Pull Requests

Matching coding standards

The CoopTilleulsForgotPasswordBundle project follows Symfony coding standards. But don't worry, you can fix CS issues automatically using the PHP CS Fixer tool. Run phpcs fixer:

vendor/bin/php-cs-fixer fix

And then, add fixed file to your commit before push. Be sure to add only your modified files. If another files are fixed by cs tools, just revert it before commit.

Sending a Pull Request

When you send a PR, just make sure that:

  • You add valid test cases (Behat and PHPUnit)
  • Tests are green
  • You add some documentation (PHPDoc & user doc: README, custom documentation file)
  • You make the PR on the same branch you based your changes on. If you see commits that you did not make in your PR, you're doing it wrong
  • Also don't forget to add a comment when you update a PR with a ping to the maintainer (@vincentchalamon), so we will get a notification
  • Squash your commits into one commit

All Pull Requests must include this header.

Squash your commits

If you have 3 commits. So start with:

git rebase -i HEAD~3

An editor will be opened with your 3 commits, all prefixed by pick.

Replace all pick prefixes by fixup (or f) except the first commit of the list.

Save and quit the editor.

After that, all your commits where squashed into the first one and the commit message of the first commit.

If you would like to rename your commit message type:

git commit --amend

Now force push to update your PR:

git push --force

License and copyright attribution

When you open a Pull Request to the CoopTilleulsForgotPasswordBundle project, you agree to license your code under the MIT license and to transfer the copyright on the submitted code to Vincent CHALAMON.

Be sure to you have the right to do that (if you are a professional, ask your company)!

If you include code from another project, please mention it in the Pull Request description and credit the original author.