contributing.md

Contributing

Thank you for contributing to this open source project.

Before you begin coding, please read the contributing guidlines of the section you want to work on.

There is a separate contributing guide for the frontend and the backend.

General contribution guildines

If you would like to contribute to this project, these are the steps you should take:

1. Find an issue in the issues tab that you think you'll be able to solve.
2. Comment on that issue that you would like to solve it, so we can assign you (avoid duplication)
3. Fork the repository to your GitHub account
4. Clone the forked repository to your computer
5. Create a new branch named by the feature you are working on
6. Make the changes necessary to solve the issue
7. Commit your changes to the new branch with a descriptive commit message (that includes the issues number)
8. Pull request your branch to the upstream/master branch
9. GitHub actions will try to build the TypeScript. If there are errors they will show on the pull request.
10. To fix any errors, just commit to your branch and they will show up on the pull request automatically
11. Done! A reviewer will check your code, and merge it when its ready

A few notes

When you commit your solution to the issue, please put the issue number in the commit message and in the pull request title + description. This links your commit and pull request so that when it is merged in, the issue is closed.

If you need any help with anything mentioned here, please just leave a comment in the issue and one of us will get back to you.