How to contribute

  • Take your pick

    What would you like to contribute? A template or code sample?

    Tell me more

  • Check the references

    Check the references for ideas and get started with your Catalyst project today!

    View code samples

  • Hit submit

    Once your masterpiece is ready, submit it for review and publication. Please do read the contribution guidelines to ensure that the contribution is valid.

    Submit your entry

*If your entry gets selected, you’ll hear from us within a week. Keep an eye on your mailbox!

 

  • Template

    Code Sample

  • A template consists of a complete code sample with a front-end and/or backend for a selected use case.

    The look and feel of the application—to help create memorable user experiences—is critical for templates.

    A code sample consists of simple code snippets that can help beginners get started with Catalyst.

    Code samples focus more on the functionality—the look and feel isn't as important.

  • Example: A comprehensive application with user authentication, Twitter feed functionality, and Twitter auto-tagging based on object recognition

    Example: A simple image processing pipeline

  • Template Reference
    Read more

    Code Sample Reference
    Read more

Template

A template consists of a complete code sample with a front-end and/or backend for a selected use case.

The look and feel of the application—to help create memorable user experiences—is critical for templates.

Example: A comprehensive application with user authentication, Twitter feed functionality, and Twitter auto-tagging based on object recognition

Template Reference
Read more

Code Sample

A code sample consists of simple code snippets that can help beginners get started with Catalyst.

Code samples focus more on the functionality—the look and feel isn't as important.

Example: A simple image processing pipeline

Code Sample Reference
Read more

Evaluation criteria

  • Quality of application

    Build the app you’d like to use

    • UI design
    • Usability
    • Latency
    • Responsiveness
    • Accessibility
  • Quality of code

    Write the code you’d like to extend

    • Readability of the code
    • Use of comments to explain different components
    • Extensibility - How easy/difficult would it be to extend the application
    • Adherence to code standards
    • Use of Catalyst components*
  • Quality of content

    Create the content you’d like to consume

    • Attention to detail
    • Covering instructions from start to finish
    • Grammar and fluency

*All projects submitted to the contributor program should be built on Catalyst. Use of Catalyst components is encouraged and also part of the evaluation criteria.

Submission guidelines

Must follow

  • All code and templates submitted will go through a standardized code review process. If plagiarized code/suspicious code is detected, then the submission will be rejected.
  • Any code sample that does not follow the Catalyst directory structure will be rejected immediately.
  • Copies of existing Catalyst tutorials with minor changes will be rejected automatically. So will tutorials that have been written without any code snippets/relevant screenshots.

Nice to follow

  • Include troubleshooting ideas for commonly faced issues in your tutorial. If it’s something you’d like to see in a tutorial, ensure that you add it in.
  • Include comments for every logical block of code, and ensure that you mention how it can be adapted for similar use cases.
  • Include similar use cases, and how they can be addressed using the sample code or template.