docs: Documentation for developing local commands - #259
Conversation
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
|
This is the first draft. I have done a very quick cursory look at the document but it needs a much more comprehensive review. There are a few things that I have found that need to be refined or extended. |
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
|
Read through it—this is going to be genuinely useful, thanks for writing it up. Three things I noticed checking the samples against the code:
I have all three patched locally if you would rather I just push them to your branch. Otherwise ping me when you take it out of draft. |
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
96d34e1 to
2ecdcb4
Compare
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
|
I have done some updates and clarifications. Also implemented your suggestions. I think that there is one outstanding item to be cleaned up before merging. This document needs to be reconciled with |
It landed under the shipped 1.1.0 heading in #259.
What this changes
Adds documentation for other developers to jumpstart their development of local commands.
Why
Mostly looking to build a framework that a developer can start with to get most of the boilerplate code without having to create it from scratch. Also looking to include recommendations and explanations to some of the common structures in the bot command files.
Testing
N/A given this is just documentation.
Checklist
devand targetingdevmake testpassesmake lintpasses (ruff + mypy)Frontend lint passes if templates changed (npm run lint:frontend)Tests added or updated for behavior changesCHANGELOG.mdupdated under## [Unreleased]if user-visibleConfig changes are reflected inconfig.ini.example(and the minimal/quickstarttemplates where relevant) — CI validates these with
validate_config.py --strictnav:inmkdocs.ymlAny new command justifies its airtime and defaults conservatively