Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shalvah authored Dec 26, 2018
1 parent 1e02195 commit 4c87b21
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Contributions are welcome.

NOTE: if your contribution changes the look of the generated documentation in some way, please include "before" and "after" screenshots in your pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
Expand Down Expand Up @@ -38,16 +36,14 @@ Before submitting a pull request:

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.
- If your contribution changes the look of the generated documentation in some way, please include "before" and "after" screenshots in your pull request.

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
- Add a description to your pull request so the reviewer knows what to look out for before looking through your changes

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

**Happy coding**!

0 comments on commit 4c87b21

Please sign in to comment.