Thank you for investing your time in contributing to our project! We will recognize any contribution you make to the project.
In this guide, we provide an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Please check out the Installation instructions on our README.
Run the partial data example and verify your outputs here.
Run the full data example and verify your outputs here.
If you spot a problem with the codebase or documentation, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you are new to contributing, you may want to check out the labels issued as "good first issue". If you find an issue to work on, you are welcome to open a PR with a fix.
We welcome any contributions. You may find areas where code can be organized better or perform tasks more efficiently, documentation can be improved, and new features can be added. You may also find small issues with existing documentation, broken links, etc., We really appreciate your time in helping to make UNSAFE better.
Make a fork and from there create a working branch to get started on your modifications. When you are modifying any code, please rerun the partial and full data examples to ensure that existing functionality continues. In general, you do not have to redownload data or unzip raw data when doing these functionality tests if you have previously run these examples.
Commit your changes and submit a pull request once you verify that the partial and full data examples still work.