Re: Editor's notes

On Mon, Feb 20, 2017 at 4:41 AM, Shane McCarron <shane@spec-ops.io> wrote:
> There is definitely a 3 way disctinction.  ReSpec, in particular, can inject
> information about "issues" and tie them into github issue discussions.
> These are distinct from "notes" (non-normative advice to the reader /
> implementor) and "ednotes" (information the editor wants to capture and
> bring to the attention of a reviewer for future action).

Note that Bikeshed can do this too; you just tag the issue with the
Github issue number. It still classifies everything that's a problem
to be resolved as an "issue", and styles them accordingly; I think
that's arguably the right thing to do.

"Note" styling (green background) should be reserved for actual spec
notes - additional info that is helpful to the reader of the spec.

~TJ

Received on Tuesday, 21 February 2017 17:44:47 UTC