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.

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

Meta-issue: Provide guidance for proposing extensions and modifications via issue templates #3477

Open
7 tasks
mfhepp opened this issue Mar 5, 2024 · 1 comment
Labels
guidelines docs examples Work on our supporting materials rather than on schema definitions

Comments

@mfhepp
Copy link
Contributor

mfhepp commented Mar 5, 2024

Many users of schema.org end up in this repository because they find that the current state of the vocabulary does not fit their individual needs, e.g. missing properties, insufficient specificity, etc.

While feedback from users is essential for schema.org, such proposals often do not end up in actual extensions to the vocabulary, which creates frustration among the submitters and puts a workload on the schema.org core contributors.

It would be good to create guidelines on (1) when and (2) how to propose changes or extensions to the vocabulary.

This could be implemented as one or multiple Github issue templates; for inspiration, see e.g. this collection of issue templates, maybe accompanied by a dedicated page in the documentation.

Here are some first ideas (maybe a bit too specific; we must not discourage users from proposing changes, of course):

Checklist

Content

  • Which applications can be expected to consume the enhanced data? (Very often, proposing an extension included the implicit expectation that major search engines will also actually use it, which will depend on many factors and take time.)
  • Can you provide URLs of Web pages that contain the respective information (e.g. that would benefit from the proposed extension)? Ideally, the URLs would be from different sites.
  • Did you check if the required information could be modeled with existing schema.org types and properties, e.g. with minor modifications to the text of existing definitions or by adding types to the domain or range?
@mfhepp mfhepp changed the title Meta-issue: Provide guidance on when and how proposals for extensions and modifications should be submitted Meta-issue: Provide guidance for proposing extensions and modifications via issue templates Mar 6, 2024
@mfhepp mfhepp added the guidelines docs examples Work on our supporting materials rather than on schema definitions label Mar 6, 2024
@mfhepp
Copy link
Contributor Author

mfhepp commented Mar 15, 2024

Some aspects are already addressed in the README. Content from there could be reused or moved and replaced by a link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
guidelines docs examples Work on our supporting materials rather than on schema definitions
Projects
None yet
Development

No branches or pull requests

1 participant