Skip to content

Commit 01494d7

Browse files
author
Andrei Igna
committed
Updated readme
1 parent 3e4254a commit 01494d7

3 files changed

Lines changed: 42 additions & 1 deletion

File tree

CONTRIBUTING

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/LayeredStudio/url-preview).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
23+
24+
25+
## Running Tests
26+
27+
``` bash
28+
$ composer test
29+
```
30+
31+
32+
**Happy coding**!

composer.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "layered/url-preview",
33
"description": "Get preview data from any URL from the internet",
44
"type": "library",
5+
"license": "MIT",
56
"keywords": ["scraper", "url-preview", "opengraph"],
67
"require": {
78
"fabpot/goutte": "^3.2"
@@ -12,6 +13,11 @@
1213
"email": "andrei.igna@layered.studio"
1314
}
1415
],
16+
"scripts": {
17+
"test": "phpunit",
18+
"check-style": "phpcs -p --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src",
19+
"fix-style": "phpcbf -p --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests"
20+
},
1521
"autoload": {
1622
"psr-4": {
1723
"Layered\\": "src/"

readme.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ URL Preview
1515
#### Installation
1616

1717
Add `layered/url-preview` as a require dependency in your `composer.json` file:
18+
``` bash
19+
$ composer require layered/url-preview
20+
```
1821

1922
#### Usage
2023

@@ -56,4 +59,4 @@ Each URL may return extra fields, present in OpenGraph tags or added by a `Layer
5659
## More
5760

5861
Please report any issues here on GitHub.
59-
Any contributions are welcome (please get in touch before submitting a PR).
62+
[Any contributions are welcome](CONTRIBUTING.md)

0 commit comments

Comments
 (0)