60 and #82 outlines plans to run module-lint on a regular cadence and then post the results in Slack (a public place). This will help our team to use this tool and start to align our repos to the module template.
If an engineer does not have proper context around this tool, however, then they may not understand what to do with the information they see in Slack and may eventually mentally skip over the messages. So, we need some documentation.
Acceptance Criteria
Documentation (as Markdown documents, in this repo, in doc/) which explains:
the purpose of module-lint / why it exists
how it works (briefly; no need for an architecture diagram)
60 and #82 outlines plans to run
module-linton a regular cadence and then post the results in Slack (a public place). This will help our team to use this tool and start to align our repos to the module template.If an engineer does not have proper context around this tool, however, then they may not understand what to do with the information they see in Slack and may eventually mentally skip over the messages. So, we need some documentation.
Acceptance Criteria
Documentation (as Markdown documents, in this repo, in
doc/) which explains:module-lint/ why it existsResources
Refer to https://github.com/MetaMask/module-lint/issues/82#issuecomment-2146279469 for what the Slack messages could look like.