search

fedora-infra / matrix-bots

Issue tracking & Development Envrionment for Fedora Matrix Bots
MIT License
3 stars 3 forks source link

add a !source command to all bots #23

Open MoralCode opened 1 month ago

MoralCode commented 1 month ago

I think it would be nice to add a !source command to all the bots that prints out a little static blurb linking to the bots repository and giving a little introduction for how to contribute (or at least linking to a wikipage or some documentation that can be more easily maintained).

I think this would have been helpful for helping guide new contributors, such as myself, towards ways they can contribute to this project

ryanlerch commented 4 weeks ago

Some things to consider here:

  1. Each "bot"/instance in maubot land is running multiple plugins that do different things and react to different commands. does the !source command show the source of all the plugins for a specific instance?
  2. Multiple bots/instances can inhabit the same room -- if you use the command !source -- all the bots will respond.

TBH, i really need to update the documentation on the matrix-bots repo -- the repo itself kinda was created to create a central space to document our bots (and the tools and plugins they use)

MoralCode commented 3 weeks ago
  1. Each "bot"/instance in maubot land is running multiple plugins that do different things and react to different commands. does the !source command show the source of all the plugins for a specific instance?

that sounds like it would be perfect, although per your second point, it may become a lot to list a link for every plugin for every bot - maybe this is something that can be done in a way thats only supported in DMs

I think the core idea of this was that it could essentially be an onboarding tool for anyone curious how the bots work or for people who encounter a bug and want to contribute a fix or issue report, so maybe just a link to the matrix channel for the bots team, or this GH repo (or whatever the entrypoint for the docs is) may also work

MoralCode commented 1 week ago

2. Multiple bots/instances can inhabit the same room -- if you use the command !source -- all the bots will respond.

i wonder if this could be namespaced somehow, like !source <bot name> causes only that bot to respond and list its plugins and their versions

Granted, my recent work with maubot makes me realize this may be harder to implement than it sounds