CONTRIBUTING.md

CONTRIBUTING

Recommended workflow

Step 1: Make your own fork.

1. Setup a GitHub account, if you haven't yet.
2. Fork the project (i.e from the github project page).
3. Clone your newly created fork:

$ git clone https://github.com/<username>/soluble-mediatools.git`

4. Install deps

$ composer update

Step 2: Change code

1. Create a new branch from master (i.e. feature/24)
2. Modify the code... Fix, improve :)

Step 3: Release a P/R (pull request)

If you have disabled .githooks:

1. First ensure the code is clean

$ composer fix
$ composer check

2. Commit/Push your pull request.

Notes

Mkdocs

If you're working on documentation, please install mkdocs, mkdocs-material...:

$ pip install -r ./requirements.txt --upgrade

You can serve the doc:

$ mkdocs serve --dev-addr localhost:8081

To publish the doc to github:

$ mkdocs gh-deploy