Skip to content

How to Contribute

nh916 edited this page Apr 20, 2023 · 14 revisions

How to Contribute

Learn the Data Model

In order to contribute or work with CRIPT, it is essential that the CRIPT data model is understood.

Within the Python SDK documentation there is also definitions for every node and how they interact with each other, but it is not a substitute for the CRIPT data model manuscript.

Note: it can be challenging when first reading and encountering the data model and how CRIPT all works together, but the more you work with it the easier it will get.

What can I help with

There is a lot that you can help with and your help is very much appreciated by the CRIPT Python SDK team. There is a lot of places to contribute ranging from fixing a typo in a documentation to implementing a new feature.

Issues

There are a lot of issues that are created as the Python SDK continues to be developed and used. Those issues can range anywhere from questions, user feature requests, or bug reports, any help with finishing those issues would be a greatly appreciated. We try to tag any issues that are good for first time contributors with good first issue label, however, if we miss some feel free to label them as you see fit.

More docs coming soon


Environment Set up

install requirements_dev.txt

  • the requirements_dev.txt has all the packages that are being used in development
pip install -r requirements_dev.txt

Install CRIPT in editable mode

pip install -e .

This is to see all of your changes to the package as you are editing the CRIPT Python SDK package


Resources

Clone this wiki locally