diff --git a/.gitattributes b/.gitattributes index e0da399..02f9cf7 100644 --- a/.gitattributes +++ b/.gitattributes @@ -8,3 +8,4 @@ phpcs.xml.dist export-ignore phpunit.dist.xml export-ignore phpstan.dist.neon export-ignore +CONTRIBUTING.md export-ignore diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2cc2fab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing + +I'm really excited that you are interested in contributing. Before submitting your contribution, please make sure to take a moment and read through the following guidelines: + +- Please open an issue to discuss fixes/features before making a pull request. +- Make sure to follow our code style. + +## Creating issues + +### Bug reports + +Always try to provide as much information as possible. If you are reporting a bug, try to provide a repro or a stacktrace at the very least. This will help us check the problem quicker. + +### Feature requests + +Lay out the reasoning behind it and propose an API for it. Ideally, you should have a practical example to prove the utility of the feature you're requesting.