# Contribution guidelines

First of all, thanks for thinking of contributing to this project. :smile:

Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.

- If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
- If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.

Please proceed with a Pull Request only after you're assigned. It'd be sad if your Pull Request (and your hardwork) isn't accepted just because it isn't ideologically compatible.

# Developing on the lib

1. Install with

    ```sh
    git clone https://github.com/websublime/schema
    cd schema
    yarn
    ```
2. Make your changes in a different git branch (say, `feat/new-rule`). These changes can be

    - adding more schema rules.
    - adding more functionality.
    - increment tests.
    - docs
    - a new idea...

3. Cover your changes with tests

6. Prepare changeset on your branch. I will ask you for a commit message and a body for description, also semver type.

```sh
yarn changeset
```

7. Push your changes

8. Wait for comments or evaluation and then it will be merged if oks.