baremetrics: Fix doc.md to match current bot documentation standards.#911
Open
hanyucrocks wants to merge 1 commit intozulip:mainfrom
Open
baremetrics: Fix doc.md to match current bot documentation standards.#911hanyucrocks wants to merge 1 commit intozulip:mainfrom
hanyucrocks wants to merge 1 commit intozulip:mainfrom
Conversation
Remove the Developer Notes section, which is internal contributor guidance rather than user-facing documentation. Fix a duplicate-word typo in the Usage section, reformat the Usage entry to match the inline example style used by other bots (xkcd, GIPHY), and add the standard "Run this bot" link after the Setup steps. Fixes zulip#910.
Author
|
I believe the CI failing is a flaky issue. Tagging @timabbott for your insights. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #910
The
doc.mdfor the Baremetrics bot had several issues compared tothe style used by other bots (xkcd, GIPHY):
## Developer Notessection, which is internal contributorguidance, not user-facing documentation.
short short descriptions).Screenshot of the revised version:

Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: