How to contribute¶

Contributions are always welcome! :)

Below are some guidelines you should follow to make sure no bugs are introduced in the process (or at least are minimized).

Get started!¶

Here’s the workflow you should follow when implementing any changes in the code and/or documentation:

If you are not a collaborator in the repo, start by forking it.
Clone either your fork (if you are not a collaborator on the repo) or the main repo (if you are a collaborator on the repo) into your machine.
```
git clone <repo_url>
```
Create a local branch starting from master, where you will implement your changes. Remember to give it a meaningful name.
```
git checkout master
git branch <branch_name>
git checkout <branch_name>
```

4. When making your changes commit often. This will make it easier to review your work. Please use semantic commit messages.

git add <file_name1>
git commit

Remember to either update the unit tests for any functions that you changed or add unit tests for any functions that you added.
Run the unit tests by going to matlab_code/tests and running run_unit_tests.
Update or add relevant documentation.
If all the unit tests pass, go ahead and push your branch to Github:
```
git push origin <branch_name>
```
On Github, create a pull request from your branch to master, provide a detailed description of the changes introduced, and wait for feedback.

Please try to follow the existing coding style.

To report a bug, please create an issue at https://github.com/biosustain/GRASP/issues.