-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCONTRIBUTING.php
40 lines (26 loc) · 1.07 KB
/
CONTRIBUTING.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Contribution guidelines
This is intended to be a public project that anyone can participate in. If you would like to add support for new functions, fix a bug, do performance optimization etc. please read this guide.
Fork, then clone the repo:
```bash
git clone git@github.com:your-username/AttributeList.git
```
Install it:
```bash
composer install
```
Make sure the tests pass:
```bash
composer run-script test
```
Make your changes. Add tests for your changes (where it makes sense). Make sure the tests pass:
```
composer run-script test
```
Push to your fork and **[submit a pull request][pr]**.
[pr]: https://github.com/apility/AttributeList/compare/
At this point you're waiting on us to accept the request. We like to at least comment on pull requests
within a week (and, typically, within 24 hours). We may suggest
some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
* [Write tests](https://phpunit.de/getting-started/phpunit-7.html)
* [Write a good commit message](.github/COMMIT_MESSAGE_GUIDELINES.md)