erlang_guidelines icon indicating copy to clipboard operation
erlang_guidelines copied to clipboard

RFC2119 compliance

Open igaray opened this issue 8 years ago • 9 comments

RFC 2119 specifies technical meanings for keywords to be used in other technical specifications and guidelines. Making the Inaka guideline documents compliant with this RFC would disambiguate and improve the wording of the guidelines.

If there is a consensus I will re-word the necessary guidelines.

igaray avatar Aug 10 '15 17:08 igaray

+1

griveroa-inaka avatar Aug 10 '15 17:08 griveroa-inaka

:+1:

elbrujohalcon avatar Aug 10 '15 17:08 elbrujohalcon

@jfacorro @amilkr @HernanRivasAcosta @Euen @davecaos ?

igaray avatar Aug 18 '15 14:08 igaray

Consistency is always nice, if you feel this is the best way to achieve it, I'm all for it.

HernanRivasAcosta avatar Aug 18 '15 15:08 HernanRivasAcosta

Would it be possible to have a few examples on how and in what cases we would use each imperative (i.e. MUST [NOT], SHOULD [NOT] and MAY) before voting?

jfacorro avatar Aug 18 '15 15:08 jfacorro

1. MUST   This word, or the terms "REQUIRED" or "SHALL", mean that the
   definition is an absolute requirement of the specification.

2. MUST NOT   This phrase, or the phrase "SHALL NOT", mean that the
   definition is an absolute prohibition of the specification.

3. SHOULD   This word, or the adjective "RECOMMENDED", mean that there
   may exist valid reasons in particular circumstances to ignore a
   particular item, but the full implications must be understood and
   carefully weighed before choosing a different course.

4. SHOULD NOT   This phrase, or the phrase "NOT RECOMMENDED" mean that
   there may exist valid reasons in particular circumstances when the
   particular behavior is acceptable or even useful, but the full
   implications should be understood and the case carefully weighed
   before implementing any behavior described with this label.

5. MAY   This word, or the adjective "OPTIONAL", mean that an item is
   truly optional.  One vendor may choose to include the item because a
   particular marketplace requires it or because the vendor feels that
   it enhances the product while another vendor may omit the same item.
   An implementation which does not include a particular option MUST be
   prepared to interoperate with another implementation which does
   include the option, though perhaps with reduced functionality. In the
   same vein an implementation which does include a particular option
   MUST be prepared to interoperate with another implementation which
   does not include the option (except, of course, for the feature the
   option provides.)

igaray avatar Aug 20 '15 13:08 igaray

+1

unbalancedparentheses avatar Sep 21 '15 15:09 unbalancedparentheses

+1

amilkr avatar Nov 07 '15 05:11 amilkr

@igaray there is technical consensus ;)

elbrujohalcon avatar Mar 07 '18 20:03 elbrujohalcon