Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 [Feature]: Proposal for Configurable Backend Integration #213

Open
sebastienfi opened this issue Jun 20, 2023 · 4 comments
Open

📚 [Feature]: Proposal for Configurable Backend Integration #213

sebastienfi opened this issue Jun 20, 2023 · 4 comments

Comments

@sebastienfi
Copy link
Contributor

sebastienfi commented Jun 20, 2023

Description

Hello wonderful OpenCommit family! 🌈 Before diving in, I must express my admiration for the code owners and contributors of OpenCommit. You folks rock! 🎸 Now, I have another proposal aimed at amplifying OpenCommit's flexibility and interoperability. 📈

OpenCommit is currently restricted to using OpenAI as the backend. Allowing configuration for alternative backends would greatly increase the project's scope and applicability. 🌐

#150

Suggested Solution

Implement a configuration mechanism that allows users to connect to any backend.

  1. Define a configuration schema with fields like backend_url, api_key, and request_format.
  2. Store this configuration in a file (e.g., backend-config.json) in ~/.opencommit/.
  3. Read the configuration at startup to determine the backend.
  4. Create an abstract BackendInterface in TypeScript for backend integrations.
  5. Develop specific backend classes that implement this interface.
  6. Use dependency injection to use the correct backend based on the configuration (?).

Alternatives

  • Hardcoding multiple backend options, but this lacks scalability.
  • Providing only a few select backends as options, but this limits the choice for users. (Self-hosted LLMs...)

Additional Context

This proposal opens up OpenCommit to a wider audience by supporting a variety of backend services. Users can connect to the backend that best fits their needs or preferences.

💡 I am excited to know what you think! Your feedback and ideas are invaluable. 💌

Thank you, OpenCommit family! 🎉

@sebastienfi sebastienfi changed the title [Feature]: Proposal for Configurable Backend Integration 📚 [Feature]: Proposal for Configurable Backend Integration Jun 20, 2023
@TommyLike
Copy link

Is there anyone working on this?

@sebastienfi
Copy link
Contributor Author

Is there anyone working on this?

Not to my knowledge. Would you like to contribute? I can assist

@github-actions
Copy link

github-actions bot commented Aug 8, 2023

Stale issue message

@di-sukharev
Copy link
Owner

we now support ollama, but im anyway reopening it, in case you want other backends, let's chat about it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants