Skip to content
This repository has been archived by the owner on Jan 27, 2022. It is now read-only.

Add Review and Comment types #227

Closed
nokome opened this issue Nov 12, 2020 · 1 comment
Closed

Add Review and Comment types #227

nokome opened this issue Nov 12, 2020 · 1 comment
Assignees
Labels

Comments

@nokome
Copy link
Member

nokome commented Nov 12, 2020

This is a proposal to add two new CreativeWork types: Review and Comment.

These will be used to implement reviews of executable preprints, specifically as the target for decoding of source content such as Google Comments and GitHub PRs as well as semantic selectors for CSS styling in Thema.

For Review I suggest the following properties (beyond those in CreativeWork):

  • itemReviewed : Thing (as defined in schema.org)
  • reviewAspect : Text (as defined in schema.org)

I don't think we should add reviewRating at this time (wait until there is a need for that) and reviewBody does not need to be added since it is provided for by content on CreativeWork (but we should provide an alias). See also Google's structured data recommendations for reviews: https://developers.google.com/search/docs/data-types/review-snippet.

For Comment I suggest the following properties (beyond those in CreativeWork):

  • parentItem : Comment (as defined in schema.org)
  • replies: Comment[] (a custom extension)

I am proposing replies because it makes more sense for in-memory and visual (HTML) representation of inter-comment relations. replies is similar to items for List.

@nokome nokome self-assigned this Nov 12, 2020
nokome added a commit that referenced this issue Nov 12, 2020
@nokome nokome closed this as completed in 89e93a3 Nov 15, 2020
stencila-ci added a commit that referenced this issue Nov 16, 2020
# [0.47.0](v0.46.5...v0.47.0) (2020-11-16)

### Bug Fixes

* **Review, Comment:** Move comments to CreativeWork ([b9bad70](b9bad70))

### Features

* **Comment:** Add comment aspect ([3c06245](3c06245)), closes [/github.com//pull/228#discussion_r522498602](https://github.com//github.com/stencila/schema/pull/228/issues/discussion_r522498602)
* **Comment:** Add comment type ([89e93a3](89e93a3)), closes [#227](#227)
* **Review:** Add review type ([0779830](0779830)), closes [#227](#227)
@stencila-ci
Copy link
Collaborator

🎉 This issue has been resolved in version 0.47.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants