-
Notifications
You must be signed in to change notification settings - Fork 5
How to Contribute
Please be sure to read through CONTRIBUTING.md file that gives a quick summary on how to contribute to the CRIPT Python SDK project.
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.
There many different kinds of examples built for CRIPT ranging from CRIPT graphs showing how nodes interact with each other to CRIPT Python and TypeScript scripts. All CRIPT resources are located at CRIPTScripts.org
There is a lot that you can help with and your help is very much appreciated. There is a lot of places to contribute ranging from fixing a typo in a documentation to implementing a new feature.
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.
Creating the perfect documentation is always a challenge and something that we strive to perfect. If something is confusing to you or you wish there was more detailed documentation for it, feel free to make your desired updates and create a pull request for it. If you find any typos within the documentation as you are reading or something doesn't look right feel free to make a pull request for it. Documentation is one of the best ways to get your feet wet and start contributing.
- the requirements_dev.txt has all the packages that are being used in development
pip install -r requirements_dev.txtpip install -e .This is to see all of your changes to the package as you are editing the CRIPT Python SDK package
When you contribute to the CRIPT Python SDK repository please be sure to put your name in the CONTRIBUTORS.md to be recognized.
Your contributions are also recognized within GitHub as well.