Skip to content

Commit 1fc9e8c

Browse files
committed
chore: add contribution
1 parent 0260ecb commit 1fc9e8c

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# CONTRIBUTING
2+
3+
Contributions are welcome, and are accepted via pull requests.
4+
Please review these guidelines before submitting any pull requests.
5+
6+
## Process
7+
8+
1. Fork the project
9+
1. Create a new branch
10+
1. Code, test, commit and push
11+
1. Open a pull request detailing your changes. Make sure to follow the [template](.github/PULL_REQUEST_TEMPLATE.md)
12+
13+
## Guidelines
14+
15+
* Please ensure the coding style running `composer lint`.
16+
* Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
17+
* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
18+
* Please remember that we follow [SemVer](http://semver.org/).
19+
20+
## Setup
21+
22+
Clone your fork, then install the dev dependencies:
23+
```bash
24+
composer install
25+
```
26+
27+
Before starting development, please ensure that [GNU Aspell](https://en.wikipedia.org/wiki/GNU_Aspell) is installed on your machine. This is required for the spell-checking functionality.
28+
29+
- **Installing Aspell:**\
30+
Please refer to the instructions in the [README](README.md) under the Installation section or the [Aspell website](http://aspell.net/) for instructions on how to install Aspell.
31+
32+
33+
## Lint
34+
35+
Lint your code:
36+
```bash
37+
composer lint
38+
```
39+
## Tests
40+
41+
Run all tests:
42+
```bash
43+
composer test
44+
```
45+
46+
Check types:
47+
```bash
48+
composer test:types
49+
```
50+
51+
Unit tests:
52+
```bash
53+
composer test:unit
54+
```

0 commit comments

Comments
 (0)