Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--
Thanks for taking the time to draft up an issue for the Axon Server API!
Prior to starting off, please read the following:

## Usage Questions

If you are having difficulty using the Axon Server API,
please consider checking Axoniq Docs first if it answers your question: https://https://docs.axoniq.io/home/

When the documentation does not cover the specific question you have, take the following into account:
- GitHub is *not* intended for usages questions, instead:
- Drop a questions on Axoniq's forum: https://discuss.axoniq.io/
- Or place a new question on StackOverflow, using the `axon` tag.

## Reporting a bug, feature, enhancement, or documentation change

Prior to filing an issue, please verify that it's not already reported by someone else.
After that's done, your issue will typically fall under one of the following options:

1. It's a `bug`
2. It's a `feature` request
3. It's an `enhancement` request
4. It's a `documentation` change

It is recommended that for either of the four you use one of the prepared issue template.
You can find all three of them [here](https://github.com/AxonIQ/axon-server-api/issues/new/choose).

## None of the above fit!

If you have encountered a use case which is not a question, nor a feature request, feel free to draft your scenario below.
-->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/1_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: 'Feature request'
about: 'Suggest a feature for the Axon Server API'
title:
type: 'Feature'
---

<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the feature description. -->

### Feature Description

<!--
Please provide a description of the feature you envision.
For example (pseudo-)code snippets showing what it might look like help us understand your suggestion better.
-->

### Current Behaviour

<!-- Please share the current behaviour of the Axon Server API around this topic, if applicable. -->

### Wanted Behaviour

<!-- Please describe the desired outcome through the Axon Server API around the suggested feature. -->

### Possible Workarounds

<!-- If applicable, share any workarounds for the described feature. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/2_enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: 'Enhancement request'
about: 'Suggest an enhancement/change to an existing feature for the Axon Server API'
title:
type: 'Enhancement'
---

<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the enhancement description. -->

### Enhancement Description

<!-- Please provide a description of the enhancement you envision. -->

### Current Behaviour

<!-- Please share the current behaviour of the Axon Server API around this topic, if applicable. -->

### Wanted Behaviour

<!-- Please describe the desired outcome through the Axon Server API around the suggested enhancement. -->

### Possible Workarounds

<!-- If applicable, share any workarounds for the described enhancement. -->
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/3_bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: 'Bug report'
about: 'Report a bug in the Axon Server API'
title:
type: 'Bug'
---

<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the bug description. -->

### Basic information

* Axon Server version:
* Axon Server API version:
* JDK version:
* Environment details:
* Complete executable reproducer if available (e.g. GitHub Repo):

### Steps to reproduce

<!--
Share all steps to be able to reproduce the bug, ideally based on a reproducer.
Combining this with a description of your setup helps us to figure out what the issue might be.
-->

### Expected behaviour

<!-- Please describe the expected behaviour. -->

### Actual behaviour

<!--
Please describe the actual behaviour as discovered.
If available, provide the entire stack trace, with markdown (```) semantics.
-->
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/4_documentation_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: 'Documentation change'
about: 'Suggest a documentation change in the Axon Server API'
title:
type: 'Documentation'
---

<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the enhancement description. -->

### Suggested Documentation change

<!-- Please provide a description of the documentation change you envision. -->