Minimal, Issue, Change request and Incident templates

INCIDENT_TEMPLATE.md

Incident: /:

---

Kind

Which kind of incident are you reporting?

• Service outage
• Security anomaly
• Resource excess
• Software delivery failure

Impact

Are users impacted by the incident? How?

Which observations can be made at this time?

How does the incident affect the system from a high-level perspective?

Timeline

Which sequence of events is known?

Further context

What else can you share about the incident?

Name Links, Anecdotes, Intuitions etc.

Similar incidents

Which previous incidents are similar to this one?

• …

Recommended mitigation

Which course of action do you suggest to remediate the situation?

• 1. …
• 2. …
• 3. …

ISSUE_TEMPLATE.md

/: <nominative, concise summary>

---

Provide a general summary of the issue in the title above.

Detailed description

Not obligatory, but provide a more detailed introduction to the case at hands, and explain why you consider it to be an issue.

Expected behaviour

Describe what you expect to happen in the observed component.

Actual behaviour

Describe the problem you are currently experiencing.

Possible resolution

Not obligatory, but suggest a reason for the observed beaviour, or ideate on how to implement a change.

Minimal reproducible example

Please provide a the smallest, complete sequence of steps to reproduce your findings.

Your environment

Name software versions, build or deployment environments, third-party platforms, etc.

Further information

Links? References? Anything that will give more context about the issue.

MINIMAL_TEMPLATE.md

As a …, I need to …, in order to …

Criteria

• [ ]

MINIMALIST_TEMPLATE.md

Answer these questions:

• What is the behaviour that you observe?
• What is the expected behaviour?
• Which change can help to mitigate the observed behaviour?
• Which further context can be given?

REQUEST_TEMPLATE.md

<nominative, concise summary>

---

Please give a general summary of the change request in the title above.

Cause for change

Is your change request related to a problem? Please describe.

Give a a clear and concise description of what the problem is.

Detailed description

A detailed description of the change or addition you are proposing.

Usage context

Why is this change important to you? How would you use it?

How can it benefit other users?

Path to implementation

Not obligatory, but suggest an idea for implementing the addition or change.

A clear and concise description of what you want to happen.

Alternatives considered

A clear and concise description of any alternative approaches you have considered.

Environment

Include as many relevant details as possible about the environment which is affected by the change.

Additional context

Screenshots? Links? References? Add any other context about the change request here.