Age | Commit message (Collapse) | Author | Files | Lines |
|
COMMON_ERRORS.md Implementation was misspelled.
Signed-off-by: Abhishek Patel <Abhishek.Patel@ibm.com>
Change-Id: I053e8ccc0aad1a900db5b385d848c12ce524643e
|
|
Lots of commits recently seem to make this error. Having this
documented should hopefully reduce the likelihood people make these
mistakes.
Tested:
Documentation only.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I72cfc06aee9d687c26aa095353c414193d5d9ce7
|
|
At least 50% of all patchsets I see adding a collection handler seem to
get this wrong, despite a small comment in the developing doc, lets add
a concrete example so that we can be sure this gets handled in the
future, and we have something to point at in code review.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I98c9e235019472d3e39a2c142b5a5aec4bca8f4e
|
|
In code review, despite them being documented, people still tend to make
these mistakes. Having them numbered allows responding with comments
that are much simpler for a maintainer, with quick comments like:
"Common error #2"
While this might not seem like a huge savings, for maintainers having to
review 10s of reviews per day, having an optimized workflow helps a lot
with time savings and little improvements add up over time.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I877cbbf50c1e20448f31464f820114073bba513e
|
|
Pretty sure the author wanted these on separate lines so do that.
Makes the list a lot easier to scan.
Could have done this multiple ways but went with bullets.
Fixed an escape.
Tested: https://jbt.github.io/markdown-editor/
Change-Id: Ia0a0e5a2023f7eebda1ebf2d4d1d6528429cce8c
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
|
|
There are a number of common coding, design, and implementation mistakes
that bmcweb users tend to make. This attempts to document them so we
have a single source to point users to when making gerrit comments. The
hope is that this alleviates some of the early mistakes that new users
tend to make.
Tested:
Documentation only. No functional changes.
Signed-off-by: Ed Tanous <ed@tanous.net>
Change-Id: Icc0081c94403c937d9a1ce44b7d6e81a5716a32e
|