swicg / swicg/groups

Use RFC 2119 language for Group actor properties

Open Beginner friendly
#45 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

report
Dominant language
HTML
Stars
8
Forks
1
PR merge metrics
No merged PRs in 30d

Description

"A group can be described like any other resource. The following terms from the ActivityStreams context (https://www.w3.org/ns/activitystreams) can be broadly useful:"

Let's change this into normative language:

  • MUST have an id (AP)
  • MUST have a type (AP)
  • SHOULD have a name (AS2)
  • MAY have summary (AS2)
  • MAY have icon
  • MAY have image
  • MUST have outbox (AP)
  • MUST have inbox (AP)
  • SHOULD have attributedTo
  • SHOULD have addressing (to, cc, bto, bcc, audience)
  • SHOULD have published
  • MAY have updated

Linking to the Activity Vocabulary and ActivityPub docs can provide the purpose and full URIs for these properties.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation for Group actor properties and compare its wording with the ActivityStreams context and ActivityPub documentation linked in the issue. Update the listed properties to use RFC 2119 terms and include their purposes and full URIs; done means each requested property has the specified normative language and references.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.