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

add documentation regarding the plugin creation and create a create plugin template #686

Open
sansyrox opened this issue Nov 8, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@sansyrox
Copy link
Member

sansyrox commented Nov 8, 2023

No description provided.

@sansyrox sansyrox added the documentation Improvements or additions to documentation label Nov 8, 2023
@13Mai13
Copy link

13Mai13 commented Mar 1, 2024

Could you give some more context here? I'm happy to contribute

@sansyrox
Copy link
Member Author

sansyrox commented Mar 2, 2024

Hey @13Mai13 👋

Thank you! 😄

There are plugins like this(https://github.com/IdoKendo/robyn_rate_limits) and we would love to add some documentation around the creation process.

And in addition to this, I was thinking of adding a scaffold repo, which would allow the developer to start a repo using a command like robyn --create-plugin and then create a base project.

@13Mai13
Copy link

13Mai13 commented Mar 22, 2024

I've started working on this. I've got a couple questions:

  • What are the minimum requirements for a plugin to work? Maybe you have something written down which could assist?
  • When passing robyn --create-plugin do we want to pass a name or do we just keep it as an example default?
  • When a developer runs --create-plugin, what did you envision would be the steps of operation? Having your thought process on this will make it easier for me to document and implement this

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

No branches or pull requests

2 participants