Skip to content

Commit 4c87b21

Browse files
authored
Update CONTRIBUTING.md
1 parent 1e02195 commit 4c87b21

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Contributions are welcome.
44

5-
NOTE: if your contribution changes the look of the generated documentation in some way, please include "before" and "after" screenshots in your pull request.
6-
75
## Etiquette
86

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

3937
## Requirements
4038

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

43-
- **[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).
41+
- Add a description to your pull request so the reviewer knows what to look out for before looking through your changes
4442

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

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

49-
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
50-
5147
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
5248

5349
**Happy coding**!

0 commit comments

Comments
 (0)