Skip to content

Commit

Permalink
Contributing guide
Browse files Browse the repository at this point in the history
Parsed together from Laravel [contributions.md](https://raw.githubusercontent.com/laravel/docs/6.x/contributions.md) (MIT) and [readme.md](https://raw.githubusercontent.com/laravel/laravel/master/readme.md) (MIT)

Relates to #15
  • Loading branch information
ivuorinen authored Oct 16, 2019
1 parent 6f826af commit f478df7
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contribution Guide

<a name="bug-reports"></a>
## Bug Reports

To encourage active collaboration, we strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.

However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem.

<a name="coding-style"></a>
## Coding Style

Laravel follows the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding standard and the [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard, so do we.

## Security Vulnerabilities

If you discover a security vulnerability within the package, please send an e-mail to [@nullthoughts](https://github.com/nullthoughts) via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

0 comments on commit f478df7

Please sign in to comment.