Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joelbutcher committed Mar 9, 2021
1 parent f4dd986 commit 2a26fd5
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,42 @@
# Contributing

Thank you for considering to contribute to Socialstream - we try and welcome everyone's ideas to improve the package. We just ask that you take a couple of minutes to carefully read through this contribution guide before you start making your changes.

## Coding Style

Like Laravel, Socialstream tries to keep to the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding style and [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard.

### PHPDoc

Below is an example of a valid documentation block, taken from the Laravel website. Note that the @param attribute is followed by two spaces, the argument type, two more spaces, and finally the variable name:

```php
/**
* Register a binding with the container.
*
* @param string|array $abstract
* @param \Closure|string|null $concrete
* @param bool $shared
* @return void
*
* @throws \Exception
*/
public function bind($abstract, $concrete = null, $shared = false)
{
//
}
```

### StyleCI

Don't worry if your code styling isn't perfect! StyleCI will automatically merge any style fixes into the repository after pull requests are merged. This allows us to focus on the content of the contribution and not the code style.

## Creating Pull Requests

Before you create n pull request, please check through our [issue tracker](https://github.com/joelbutcher/socialstream/issues) to make sure that no one has had the same idea! If you've noticed something similar to your request, please "upvote" it so that it get's more attention from the maintainers.

When making a pull request, please make sure to outline as concisely as possible the reason for it, what benefits it brings or what it fixes - screenshots and code-snippets that support your request are **highly** encouraged. When you are ready to make your pull request, please be sure to give it a good name (PR's like 'patch-1' will be rejected). As an example we recommnend pre-fixing your request with the verion number you are targeting. e.g. `[3.x] Allow accounts to be removed`

## Testing

When making you changes or additions, we **strongly** encourage you to write tests to ensure compatibility. Make sure to check out our [existing test suite](https://github.com/joelbutcher/socialstream/tree/2.x/tests) for examples of how to do this and create equivalent tests accordingly

0 comments on commit 2a26fd5

Please sign in to comment.