# How to contribute

## Philosophy

TODO

## Best practices

TODO

## How to get your changes merged

- Fork this repository

- Clone your repository

  1. Alternatively, you can add a remote called `fork`:

  `$  git remote add fork https://dev.tildefriends.net/YOUR_USERNAME/tildefriends.git`

  You'll need to set your branch's upstream to `fork`:

  `$ git push --set-upstream fork my-branch`

  2. or you can change the `origin` remote on your existing clone altogether:

  `$ git remote set-url origin https://dev.tildefriends.net/YOUR_USERNAME/tildefriends.git`

- Make your changes

  - I want to edit C code !

    TODO

  - I want to edit JavaScript code !

    TODO

  - I want to write documentation !

    Great! Before you do, have a look at the [documentation guidelines](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/documentation-guidelines.md) to learn how to write consistent documentation.

    In all cases:

    - Make sure that your commit messages are descriptive.
    <!-- - hi -->

- Format your changes:

If you've edited C code: run `make format`

If you've edited JavaScript code or the documentation: run `npm run format`

- Open a pull request

TODO

- Get your changes reviewed and merged

TODO