Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RFC2119 capitalisation #44

Closed
keunes opened this issue Jun 17, 2023 · 1 comment
Closed

RFC2119 capitalisation #44

keunes opened this issue Jun 17, 2023 · 1 comment
Assignees
@Sporiff

Comments

@keunes
Copy link
Member

keunes commented Jun 17, 2023 •
edited
Loading

The capitalisation comes from RFC2119, which defined some keywords practical for specification designing. E.g. SHOULD is defined as:

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.

So the capitalisation indicates that this definition is used.

If we decide to use this, we have to put the following text somewhere prominent in the spec:

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
[RFC 2119](https://www.rfc-editor.org/rfc/rfc2119).

Originally posted by @JonOfUs in #42 (comment)
@keunes keunes mentioned this issue Jul 5, 2023
Closed
@Sporiff Sporiff self-assigned this Jan 28, 2024
Sporiff added a commit that referenced this issue Feb 2, 2024
@Sporiff
Use RFC2119 capitalization
e1b0ef1 
Addresses the point raised in #44
@Sporiff
Copy link
Member

Sporiff commented Feb 2, 2024

Fixed in e1b0ef1

@Sporiff Sporiff closed this as completed Feb 2, 2024
Sporiff added a commit that referenced this issue May 6, 2024
@Sporiff
Use RFC2119 capitalization
5d81dc8 
Addresses the point raised in #44
keunes added a commit that referenced this issue May 6, 2024
@keunes
Squashed commit of the following:
1eaef5e 
commit 2926a6b
Author: Ciarán Ainsworth <[email protected]>
Date:   Mon May 6 18:09:56 2024 +0200

    Disable GH pages

commit 1458cad
Author: Keunes <[email protected]>
Date:   Wed May 1 08:45:13 2024 +0200

    About page tweaks

commit fd031f2
Author: Ciarán Ainsworth <[email protected]>
Date:   Wed May 1 02:41:24 2024 +0200

    Add syncing tabs

commit 39f81c2
Author: Ciarán Ainsworth <[email protected]>
Date:   Tue Apr 23 02:06:18 2024 +0200

    Add Netlify to homepage

commit f2a01cd
Author: Keunes <[email protected]>
Date:   Mon Apr 22 09:10:04 2024 +0200

    Add contact method to Code of Conduct

commit 52a42cb
Author: Ciarán Ainsworth <[email protected]>
Date:   Thu Apr 11 22:04:15 2024 +0200

    Add support for OAPI explorer

commit 6088999
Author: Ciarán Ainsworth <[email protected]>
Date:   Thu Apr 11 22:04:01 2024 +0200

    Use PNG instead of SVG for Image integration

commit fe8a9e5
Author: Ciarán Ainsworth <[email protected]>
Date:   Fri Feb 2 15:32:25 2024 +0100

    Bump dependencies

commit bbb1688
Author: Ciarán Ainsworth <[email protected]>
Date:   Fri Feb 2 15:08:47 2024 +0100

    Update src/components/Sidebar.astro

    Co-authored-by: Jonathan Flueren <[email protected]>

commit 5d81dc8
Author: Ciarán Ainsworth <[email protected]>
Date:   Fri Feb 2 14:38:57 2024 +0100

    Use RFC2119 capitalization

    Addresses the point raised in #44

commit 23ff44d
Author: Ciarán Ainsworth <[email protected]>
Date:   Fri Feb 2 14:26:42 2024 +0100

    Add new sidebar component

    To support adding a persistent link to the sidebar, we need to maintain our own component.

    This commit takes the original component from the Starlight codebase and appends our link.

commit bef3645
Author: Ciarán Ainsworth <[email protected]>
Date:   Sun Jan 28 16:31:00 2024 +0100

    Add CoC to main site

commit 7e75d21
Author: Ciarán Ainsworth <[email protected]>
Date:   Sun Jan 28 16:30:43 2024 +0100

    Bump dependencies

commit 0896bed
Author: Keunes <[email protected]>
Date:   Sun Jan 28 11:18:30 2024 +0100

    Create CODE_OF_CONDUCT.md

commit 8ca85d2
Author: Ciarán Ainsworth <[email protected]>
Date:   Tue Dec 5 14:32:13 2023 +0100

    chore(deps): Bump dependencies

commit 5e2d386
Author: Ciarán Ainsworth <[email protected]>
Date:   Tue Nov 21 00:35:33 2023 +0100

    chore(deps): bump dependencies

commit 12d8848
Author: Keunes <[email protected]>
Date:   Wed Sep 13 08:20:56 2023 +0200

    Infrastructure credit

commit 3d2087a
Author: Jonathan Flueren <[email protected]>
Date:   Mon Sep 11 14:03:16 2023 +0200

    Adapt GH-actions to Starlight
    Deployments will be handled by Netlify, until then `main` will still be deployed by GitHub

commit ecc3057
Author: Jonathan Flueren <[email protected]>
Date:   Mon Sep 11 13:52:36 2023 +0200

    Fix links and sidebar

commit 5eae352
Author: Keunes <[email protected]>
Date:   Mon Sep 11 06:44:34 2023 +0200

    Update content in Starlight site version (#52)

commit 17a7ccb
Author: Ciarán Ainsworth <[email protected]>
Date:   Wed Sep 6 03:14:52 2023 +0200

    Add missing update document

commit a47c10b
Author: Ciarán Ainsworth <[email protected]>
Date:   Wed Sep 6 01:15:37 2023 +0200

    feat: split up overview and add CoC link.

commit 0170946
Author: Ciarán Ainsworth <[email protected]>
Date:   Wed Sep 6 01:07:47 2023 +0200

    feat(docs): update code blocks

commit b6e7c53
Author: Ciarán Ainsworth <[email protected]>
Date:   Wed Sep 6 01:07:39 2023 +0200

    feat: add expressive code blocks and bump deps

commit c55e02a
Author: Ciarán Ainsworth <[email protected]>
Date:   Sun Aug 27 16:07:34 2023 +0200

    feat: auto-import components

commit 998a2fd
Author: Ciarán Ainsworth <[email protected]>
Date:   Fri Aug 25 13:22:19 2023 +0200

    fix: typo

commit 0b80720
Author: Ciarán Ainsworth <[email protected]>
Date:   Sun Aug 20 20:03:16 2023 +0200

    feat: migrate to Starlight

commit 73b6cee
Author: Ciarán Ainsworth <[email protected]>
Date:   Thu Apr 25 16:25:29 2024 +0200

    Add Sporiff to contributors list

commit bd239be
Author: Bart De Vries <[email protected]>
Date:   Thu Apr 25 14:06:27 2024 +0200

    Add mogwai to team

commit c2ae0ca
Author: Jonathan Flueren <[email protected]>
Date:   Thu Apr 25 12:59:41 2024 +0200

    Add @JonOfUs to team list (#74)

commit 1b4276f
Author: Keunes <[email protected]>
Date:   Thu Apr 25 00:36:23 2024 +0200

    Update README.md

    Add link to meeting notes and start table with contributors.

commit e39293e
Author: Keunes <[email protected]>
Date:   Wed Sep 13 09:09:36 2023 +0200

    Create LICENSE.md

    As agreed at the 2023-09-05 meeting, our Specifications are released under the Creative Commons Attribution-ShareAlike license
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Sporiff Sporiff

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@keunes @Sporiff