Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kleninmaxim authored Jul 30, 2023
1 parent 4bd4042 commit 1a40519
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# CONTRIBUTION GUIDELINES

Contributions are **welcome** and will be fully **credited**.

We accept contributions via pull requests on GitHub. Please review these guidelines before continuing.

## Guidelines

1) Please follow the [StyleCI](https://styleci.io/).
2) Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
3) If you are changing or adding to the behaviour or public API, you may need to update the docs.
4) Please remember that we follow [Semantic Versioning](https://semver.org/).

## Running Tests

First, run StyleCI:

```bash
./vendor/bin/php-cs-fixer fix .
```

Second, run the tests:

```bash
phpunit
```

0 comments on commit 1a40519

Please sign in to comment.