Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crynobone authored Dec 28, 2019
1 parent 045e895 commit 5c52165
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,31 @@
# Contributing

Contributions are welcome and will be fully credited.
Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

We accept contributions via Pull Requests on [GitHub](https://github.com/staudenmeir/dusk-updater).
## Guidelines

## Pull Requests
* Please follow the [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).
* Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
* Remember that we follow [SemVer](http://semver.org). If you are changing the behaviour, or the public api, you may need to update the docs.
* Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash](http://git-scm.com/book/en/Git-Tools-Rewriting-History) them before submitting.
* You may also need to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) to avoid merge conflicts.

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
## Running Tests

- **Add tests** - Your patch won't be accepted if it doesn't have tests.
You will need an install of [Composer](https://getcomposer.org) before continuing.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
First, install the dependencies:

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org). Randomly breaking public APIs is not an option.
```bash
$ composer install
```

- **Create feature branches** - Don't ask us to pull from your master branch.
Then run phpunit:

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
```bash
$ vendor/bin/phpunit
```

- **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.
If the test suite passes on your local machine you should be good to go.

## Running Tests

```
vendor/bin/phpunit
```
When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/) on multiple php versions and hhvm.

0 comments on commit 5c52165

Please sign in to comment.