Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 3.01 KB
Raw

Contributing to Pipelines

🚀 Welcome, Contributors! 🚀

We are thrilled to have you join the Pipelines community! Your contributions are essential to making Pipelines a powerful and versatile framework for extending OpenAI-compatible applications' capabilities. This document provides guidelines to ensure your contributions are smooth and effective.

📌 Key Points

  • Scope of Pipelines: Remember that Pipelines is a framework designed to enhance OpenAI interactions, specifically through a plugin-like approach. Focus your contributions on making Pipelines more robust, flexible, and user-friendly within this context.
  • Open WebUI Integration: Pipelines is primarily designed to work with Open WebUI. While contributions that expand compatibility with other platforms are welcome, prioritize functionalities that seamlessly integrate with Open WebUI's ecosystem.

🚨 Reporting Issues

Encountered a bug or have an idea for improvement? We encourage you to report it! Here's how:

  1. Check Existing Issues: Browse the Issues tab to see if the issue or suggestion has already been reported.
  2. Open a New Issue: If it's a new issue, feel free to open one. Follow the issue template for clear and concise reporting. Provide detailed descriptions, steps to reproduce, expected outcomes, and actual results. This helps us understand and resolve the issue efficiently.

🧭 Scope of Support

  • Python Fundamentals: Pipelines leverages Python. Basic Python knowledge is essential for contributing effectively.

💡 Contributing

Ready to make a difference? Here's how you can contribute to Pipelines:

🛠 Pull Requests

We encourage pull requests to improve Pipelines! Here's the process:

  1. Discuss Your Idea: If your contribution involves significant changes, discuss it in the Issues tab first. This ensures your idea aligns with the project's vision.
  2. Coding Standards: Follow the project's coding standards and write clear, descriptive commit messages.
  3. Update Documentation: If your contribution impacts documentation, update it accordingly.
  4. Submit Your Pull Request: Submit your pull request and provide a clear summary of your changes.

📚 Documentation

Help make Pipelines more accessible by:

  • Writing Tutorials: Create guides for setting up, using, and customizing Pipelines.
  • Improving Documentation: Enhance existing documentation for clarity, completeness, and accuracy.
  • Adding Examples: Contribute pipelines examples that showcase different functionalities and use cases.

🤔 Questions & Feedback

Got questions or feedback? Join our Discord community or open an issue. We're here to help!

🙏 Thank You!

Your contributions are invaluable to Pipelines' success! We are excited to see what you bring to the project. Together, we can create a powerful and versatile framework for extending OpenAI capabilities. 🌟