Document coding conventions and best practices for spec maintainers #525
Conversation
There was a problem hiding this comment.
Thank you @inexorabletash for this useful guidance and spec writing conventions. It looks good to me. @huningxin
inexorabletash
force-pushed
the
coding-conventions
branch
from
efceea6 to
b560450
Compare
As suggested by @wchao1115 in webmachinelearning#499 and webmachinelearning#518, create a doc capturing past WG disscussions in the telecons, issues, and PRs, so that we can be consistent going forward.
inexorabletash
force-pushed
the
coding-conventions
branch
from
b560450 to
d74351c
Compare
|
I'm pleased to merge this PR that makes the editors' and other spec contributors' lives so much easier. Thanks @inexorabletash! I assume you're already thinking of upstreaming the novel parts of this contribution to Bikeshed docs. These magic spells need to be shared with the entire community using Bikeshed so other spec efforts can benefit too. Good quality docs are so important for a tool such as Bikeshed. There's at least 3 resources I know of that cover this topic, and having guidelines synthesized in this fashion is so helpful. Maybe there's already an effort to unify the more generic docs. |
As suggested by @wchao1115 in #499 and #518, create a doc capturing past WG disscussions in the telecons, issues, and PRs, so that we can be consistent going forward. I'm reasonably sure I didn't capture everything, and I tried not to repeat the contents of Infra too much, but this captures most of the recent discussions I've been involved in. But it's a start!
I'd encourage the editors to edit this PR directly with any suggestions.