Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fzaninotto committed Jul 21, 2015
1 parent e161d6e commit 5594929
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -5,7 +5,7 @@ If you've written a new formatter, adapted Faker to a new locale, or fixed a bug

Before proposing a pull request, check the following:

* Your code should follow the [PSR-2 coding standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) (and use [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) to fix inconsistencies).
* Your code should follow the [PSR-2 coding standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). Run `make sniff` to check that the coding standards are followed, and use [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) to fix inconsistencies.
* Unit tests should still pass after your patch. Run the tests on your dev server (with `make test`) or check the continuous integration status for your pull request.
* As much as possible, add unit tests for your code
* Never use `rand()` in your providers. Faker uses the Mersenne Twister Randomizer, so use `mt_rand()` or any of the base generators (`randomNumber`, `randomElement`, etc.) instead.
Expand Down

4 comments on commit 5594929

@vinkla
Copy link
Contributor

@vinkla vinkla commented on 5594929 Jul 21, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fzaninotto What about adding StyleCI? Then all commits and PRs will be checked automagically.

If you're up to it I can submit a PR.

@fzaninotto
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already check both style and unit tests in the CI build, see

script: make sniff test

@GrahamCampbell
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fzaninotto Running cs checks on travis is a bad idea. You surely want to tell if the tests fail separately to if the cs fails, straight away.

@fzaninotto
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the "right away". You mean for developers, before they submit a PR? Well, they have a make sniff command, I can't do more. And I do want a CS check for every PR, so instead of asking for a second build, I put it all in the same build. I don't see the problem.

Please sign in to comment.