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

Consider introducing Issue Templates #546

Open
csarven opened this issue Jul 26, 2023 · 3 comments
Open

Consider introducing Issue Templates #546

csarven opened this issue Jul 26, 2023 · 3 comments

Comments

@csarven
Copy link
Member

csarven commented Jul 26, 2023

It may help to introduce some issue templates.

Let's process https://github.com/solid/specification/blob/main/CONTRIBUTING.md (e.g., Work Item Proposals) and other material elsewhere to see what would be useful to template.

  • New Work Item Proposal
  • Use Case Proposal - This may need to be in https://github.com/solid/user-stories or Work Item repo specific?
  • Work Item Change Proposal - identify intended/anticipated change using W3C correction classes (issue should be for "significant" classes 3-5).
  • Dedicated Meeting Proposal (topic, time, location, focus..)
  • ...
@woutermont
Copy link
Contributor

Some other possible templates:

  • implementation questions: what is the context/setup, what is the question, what has already been done to find an answer (where was the answer expected) ...

  • implementation feedback (which not yet resulted in concrete work item change request): what was the context/setup, did everything conform, what went wrong or could be better ...

  • demo (to document): what was the context/setup, what does it demo, where can we find the demo ...


Re issues that should be raised somewhere else (e.g. use cases): can the template picker display some references next to the available templates?

@elf-pavlik
Copy link
Member

Yes, it can have a link, see for example: https://github.com/solid/authorization-panel/issues/new/choose

@woutermont
Copy link
Contributor

Yes, it can have a link, see for example: https://github.com/solid/authorization-panel/issues/new/choose

This is just perfect design; makes me happy 😊

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

No branches or pull requests

3 participants