tildefriends/docs/contributing.md

How to contribute

• Fork this repository

• Clone your repository

Alternatively, you can change the origin remote on your existing clone:

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 to learn how to write consistent documentation.

  In all cases:

  • Make sure that your commit messages are descriptive.

• 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