Skip to content

Commit 3bcac63

Browse files
committed
Added CONTRIBUTING.md & update Contribute section from Readme
1 parent ed53eb4 commit 3bcac63

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
First of all, thank you for taking time to contribute!
4+
5+
Contributions are accepted via Pull Requests on [Bitbucket][repo]. Sometimes, our free time is very limited and could take a while until we review your pull request, so please be patient while you wait for code review.
6+
7+
We don't mind getting questions, so if you have any, please open a new issue on our [tracker][repo].
8+
9+
## Pull Requests
10+
11+
Here are a few rules which you should follow, in order to ease code review and merging:
12+
13+
1. **Follow [PSR-2 Coding Standard][PSR-2]**
14+
- **Create feature branches** - We don't pull from your (master|develop) branch!
15+
- **One pull request per feature** - If you need/want to change more than one thing, please send multiple pull requests.
16+
- **Consider our release cycle** - We follow [SemVer v2.0.0][semver]. Breaking public APIs is not acceptable.
17+
- **(Add|Update) tests when applicable.**
18+
- **Document any change in behaviour** - Update documentation and/or readme file when applicable.
19+
20+
Sometimes you might be asked to also [squash your commits][squash] (*we don't want commits such as `fix 1`, `fix <n>`, `now its working`, etc*). This is done in order to keep a clean and coherent VCS history.
21+
22+
## Running tests
23+
24+
``` bash
25+
$ composer test
26+
```
27+
28+
To check against [PSR-2][PSR-2] coding standard:
29+
30+
``` bash
31+
$ composer style
32+
```
33+
34+
[repo]: https://bitbucket.org/gentlero/bitbucket-api/overview
35+
[PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
36+
[squash]: http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
37+
[semver]: http://semver.org/

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ See [http://gentlero.bitbucket.org/bitbucket-api/](http://gentlero.bitbucket.org
2828

2929
## Contribute
3030

31-
Send pull requests on [Bitbucket](https://bitbucket.org/gentlero/bitbucket-api).
31+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
32+
3233

3334
## Credits
3435

0 commit comments

Comments
 (0)