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.
Like Laravel, Socialstream tries to keep to the PSR-2 coding style and PSR-4 autoloading standard.
Below is an example of a valid documentation block. Where possible, please fully type your method arguments and return types.
/**
* Register a binding with the container.
*
* @throws \Exception
*/
public function bind(string $abstract, callable|string|null $concrete = null, bool $shared = false): void
{
//
}Don't worry if your code styling isn't perfect! Code styling will be resolved when your PR is merged into main.
Before you create n pull request, please check through our issue tracker 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
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 for examples of how to do this and create equivalent tests accordingly