Skip to content

Commit 6f6c017

Browse files
authored
Create CONTRIBUTING.md
1 parent 5aa5f97 commit 6f6c017

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Contributing
2+
============
3+
4+
Found a bug? Wanna Implement a missing feature? Or you have a suggestion or two;
5+
just create an issue with a description of your intentions and we can start from there.
6+
7+
Running The Tests
8+
=================
9+
Your environment should be setup for php development.
10+
I used [Laragon]() as my local environment while building the package.
11+
12+
To run the tests:
13+
- fork the repo
14+
- clone the your fork of the repo
15+
- run `composer install` in the root dir of the cloned repo
16+
- set up the config as specified in the README
17+
- then run
18+
```
19+
"./vendor/bin/phpunit"
20+
```
21+
Implementing Mising Feature
22+
===========================
23+
Before attempting to implement a new feature, first create an issue about it and check to ensure nobody else is working on it.

0 commit comments

Comments
 (0)