Templates for New Issues

[RaggedStaff]

Discussed in https://github.com/orgs/datafoodconsortium/discussions/16

^{Originally posted by RaggedStaff February 11, 2024}
@RachL has proposed we have some templates to simplify the raising of issues & improve/enrich the information provided (particularly within the Ontology & Taxonomies repositories).

I'm thinking we probably want a Bug Report and a Feature Request. Can anyone think of any others?

I've had a quick stab at templates for both of those:

Bug Report (Ontology)

---

name: Bug report
about: Create a report to help us improve
title: '[BUG] Give a title'
labels: 'bug'
assignees: ''

---

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):

• Ontology Version [e.g. 1.8.2]
• Classes Impacted [e.g orderLine, enterprise, physicalProduct ]
• Properties Impacted [e.g. orderLine:hasQuantity does not accept non-integer values]

Additional context
Add any other context about the problem here.

Feature Request (Ontology)

---

name: Feature request
about: Suggest an idea to extend the standard
title: '[FEATURE] Give a title'
labels: 'enhancement'
assignees: ''

---

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Include any Classes and/or Properties that are impacted. E.G. It's not possible to [...]

Describe the solution you'd like
A clear and concise description of what you want to happen. Include any Use Case(s) that are applicable

Describe alternatives you've considered
A clear and concise description of any alternative solutions, features, or work-arounds you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Bug Report (Taxonomies)

---

name: Bug report
about: Create a report to help us improve
title: '[BUG] Give a title'
labels: 'bug'
assignees: ''

---

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots or diagrams to help explain your problem.

Environment (please complete the following information):

• Taxonomy Version [e.g. 1.2.0]
• Taxonomies Impacted [e.g productTypes.rdf, measures.json ]
• Concepts Impacted [e.g. dfc-m:CanadianDollar, dfc-v:FulfilmentState]

Additional context
Add any other context about the problem here.

Feature Request (Taxonomies)

---

name: Feature request
about: Suggest an idea to extend the standard
title: '[FEATURE] Give a title'
labels: 'enhancement'
assignees: ''

---

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Include the taxonomies that are impacted, and any concepts you're proposing.

Describe the solution you'd like
A clear and concise description of what you want to happen. Include any Use Case(s) that are applicable

Describe alternatives you've considered
A clear and concise description of any alternative solutions, features, or work-arounds you've considered.

Additional context
Add any other context or screenshots about the feature request here.