Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joelbutcher authored Dec 6, 2023
1 parent 212e55b commit 9d3e191
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,23 @@ Like Laravel, Socialstream tries to keep to the [PSR-2](https://github.com/php-f

### 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:
Below is an example of a valid documentation block. Where possible, please fully type your method arguments and return types.

```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)
public function bind(string $abstract, callable|string|null $concrete = null, bool $shared = false): void
{
//
}
```

### StyleCI
### Code Style

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.
Don't worry if your code styling isn't perfect! Code styling will be resolved when your PR is merged into `main`.

## Creating Pull Requests

Expand Down

0 comments on commit 9d3e191

Please sign in to comment.