Contributing

🚀 We believe in the power of community collaboration and deeply value your contributions.

Whether you're a developer, designer, writer, or user, there are multiple ways you can contribute.

Star

Give a star ⭐️ to and share the main GitHub repository of Instill Core.

Providing Feedback

Navigate to the main GitHub repository of Instill Core. This repository serves as the central platform for discussing the project, reporting issues, and sharing your innovative ideas.

File a Bug

Report issues or unexpected behavior in the product.

Request a Feature

Share ideas for new features you’d love to see.

Suggest an Improvement

Propose refinements or enhancements to existing features.

Request a Tutorial

Ask for a step-by-step guide to help you use the platform.

Share Your Work

Sharing how you utilize Instill Core is a form of contribution. It allows others to clone your pipeline and apply it to their own projects. On the Console pipeline page, press the Share button to share your pipeline. You can choose to Make the Pipeline Public or Share by Link, then press Copy Link, attach a screenshot, and share it in the #show-your-work channel on Discord.

Contributing by Coding

We highly appreciate contributions to the Instill Core projects in the form of code. To embark on this collaborative coding journey, please consult the Contributing Guidelines in each respective codebase repository.

Instill Core (cloud-hosted)

Contribute to the Instill Core engine for model and pipeline orchestration.

Console

Help improve the web-based UI for interacting with Instill Core.

CLI

Enhance the command-line interface for managing pipeline components.

Python SDK

Contribute to the official Python SDK for Instill AI.

TypeScript SDK

Help build the TypeScript SDK for integrating with Instill AI.

Additionally, you can learn how to set up your local development environment here.

📖 Contributing to Cookbook

Follow the guideline to help enhance our notebooks and make them more accessible and informative. Your contributions can help users better understand our projects.

🙌 Community Management and Support

Join our Discord and take an active role in fostering a welcoming and supportive community. Help answer questions, assist fellow members, and ensure a positive atmosphere.

🎙️ Advocating

Spread the word about our projects and the positive impact they can have. Advocate for our mission and help us reach a broader audience.

Stay tuned for forthcoming detailed guidelines on how you can contribute effectively! 🌱