8000 Implementation Report Template by gobengo · Pull Request #174 · w3c/activitypub · GitHub
[go: up one dir, main page]

Skip to content

Conversation

gobengo
Copy link
@gobengo gobengo commented Jan 11, 2017

Readable version: https://github.com/gobengo/activitypub/blob/implementation-reports/implementation-reports/TEMPLATE.md

Seeking input here on general structure. I think probably the "Feature Acceptance Criteria" should be assertions in the test suite, and not checkboxes in the implementation report. If others agree, then gather those bullets can be the basis of a test suite.

  • Implementation information
  • Client Section (remove if inapplicable)
    • ...Client Feature
      • ...Feature Acceptance Criteria
  • Servers (remove if inapplicable)
    • ...Server Feature
      • ...Feature Acceptance Criteria

I started my list of "Features" from the Exit Criteria features enumerated in 2.2. However, I am also grepping through the normative language of the spec, and some MUSTs describe behaviors outside of the 2.2 Features (e.g. Object Retrieval). Not sure if that's a problem, just pointing it out, as it could lead to there being 2 implementations of each Exit Criteria feature, but with all of those implementations ignoring MUSTs in the spec.
@cwebber do you think it's worth adding any of the following features as relevant for Exit Criteria?

  • Object Retrieval
  • Inbox Retrieval

I also filed #173 while working on this.

@gobengo gobengo force-pushed the implementation-reports branch from 159f4fd to 15f5dc1 Compare January 11, 2017 09:39
@gobengo gobengo force-pushed the implementation-reports branch from 15f5dc1 to bd97e86 Compare January 11, 2017 09:40
@gobengo
Copy link
Author
gobengo commented Jan 11, 2017

I believe this now has all all the Client requirements backed by normative language

@gobengo gobengo force-pushed the implementation-reports branch from b0165cf to 13a546a Compare January 12, 2017 10:56
@gobengo gobengo changed the title WIP: Start Implementation Report Template Implementation Report Template Feb 28, 2017
@cwebber
Copy link
Collaborator
cwebber commented Mar 3, 2017

This looks really good. Thank you for your amazing work on it! And sorry it took me so long to review it.

I think everything looks good to go and ready to merge, I'm just thinking of adding one thing... the upload media section of the document asks for the user to provide both the file and also a shell of the object (and for the server to expect / process that). Maybe that should be added to the implmeentation report as well, or do you think that's already covered from the present wording?

@gobengo
Copy link
Author
gobengo commented Mar 4, 2017 via email

@cwebber
Copy link
Collaborator
cwebber commented Mar 4, 2017

That sounds good to me. I'm going to merge this with that change. Sound good to you?

@gobengo
Copy link
Author
gobengo commented Mar 4, 2017 via email

@cwebber cwebber merged commit 5daddcb into w3c:gh-pages Mar 4, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0