Skip to content

Commit d730da1

Browse files
committed
chore: add CONTRIBUTING.md
1 parent 0c36fe4 commit d730da1

File tree

2 files changed

+53
-7
lines changed

2 files changed

+53
-7
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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.
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+
28+
Build workbench:
29+
```bash
30+
composer build
31+
```
32+
33+
## Playground
34+
35+
You can visit a test application via [Workbench](https://github.com/orchestral/workbench):
36+
```bash
37+
composer serve
38+
```
39+
40+
## Lint
41+
42+
Lint your code:
43+
```bash
44+
composer lint
45+
```
46+
## Tests
47+
48+
Run all tests:
49+
```bash
50+
composer test
51+
```
52+

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,19 +130,13 @@ will be processed as:
130130
http://localhost:8000/image-transform/width=250,format=webp/example.jpg
131131
```
132132

133-
## Testing
134-
135-
```bash
136-
composer test
137-
```
138-
139133
## Changelog
140134

141135
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
142136

143137
## Contributing
144138

145-
TODO
139+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
146140

147141
## Credits
148142

0 commit comments

Comments
 (0)