CORTX Hackathon submission guidelines

Thank you for participating in the CORTX Hackathon! 

If you have made it this far. Congratulations! All you need to do is submit your integration for judging.

Here is a good example.

Here are the submission instructions:

Step 1: You'll need one of your team members to have a Github account. Sign up for one if you have not already done so.

Step 2: Fork the CORTX repository so that you can make a pull request.

Step 3: In that fork create a .md Markdown file that explains your integration in the integrations folder

In that integration page you will need

• A write up that includes:

• The intention behind the integration and what it does.
• Installation directions that are clear, accessible, and easily reproducible.
• Expected outputs, and possibly common errors and what they mean.
• Screenshots.

• A video which includes:

• An explanation of the integration use case - why/how it is useful or impactful in addition to demonstrating how to set up and run the integration.
• Directions on how to install the integration should be easily understood, concise, and contain relevant visuals, and easily reproduced.
• Tips on how to know if things are successful or have failed.

Step 4: Add a link to your newly created integration page to the top-level integration page

Step 5: Add the a link to the pull request of your submission on Devpost.  

Tips on creating an outstanding submission

Want to ensure your submission is the best of the best? Watch this video or read these tips on what we look for in an outstanding submission.

• A demonstrably working integration between CORTX and another system, tool, or platform that has high impact potential (e.g. a tool, system, or platform that is core to multiple industries or domains)
• The integration should be submitted to the CORTX main repository on GitHub as a pull request. The pull request should also include written documentation which briefly defines the intention behind the integration and what it does, in addition to all necessary instructions and documentation. An outstanding pull request will include directions that are clear, accessible, and easily reproducible. The inclusion of relevant screenshots, expected outputs and/or common errors and what they mean is the mark of an exemplary submission.
• A video that briefly explains the integration, demonstrates its functionality, and provides instructions in how to set up and run the integration should be created and linked in the pull request. And outstanding submission would include an explanation of the integration use case- in other words, why and how it is useful or impactful. An exemplary video will be marked by directions that are easily understood, concise, and contain relevant visuals. An outstanding submission will have instructions are easily reproduced and include tips on how to know if set up has succeeded or failed.
• Submissions will also earn points based on their technical complexity. An integration that connects to a platform that is very complex or which uses a large number of different functions will score more highly than a simple integration. Alternatively, an submission that integrates with the Motr core rather than the S3 layer will score highly under the technical complexity category.