Skip to content

Commit 8213529

Browse files
authored
Merge pull request #68 from AxonIQ/feature/github-issue-templates
Include GitHub issue templates
2 parents 3c049cf + 8095c8a commit 8213529

File tree

5 files changed

+128
-0
lines changed

5 files changed

+128
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
Thanks for taking the time to draft up an issue for the Axon Server API!
3+
Prior to starting off, please read the following:
4+
5+
## Usage Questions
6+
7+
If you are having difficulty using the Axon Server API,
8+
please consider checking Axoniq Docs first if it answers your question: https://https://docs.axoniq.io/home/
9+
10+
When the documentation does not cover the specific question you have, take the following into account:
11+
- GitHub is *not* intended for usages questions, instead:
12+
- Drop a questions on Axoniq's forum: https://discuss.axoniq.io/
13+
- Or place a new question on StackOverflow, using the `axon` tag.
14+
15+
## Reporting a bug, feature, enhancement, or documentation change
16+
17+
Prior to filing an issue, please verify that it's not already reported by someone else.
18+
After that's done, your issue will typically fall under one of the following options:
19+
20+
1. It's a `bug`
21+
2. It's a `feature` request
22+
3. It's an `enhancement` request
23+
4. It's a `documentation` change
24+
25+
It is recommended that for either of the four you use one of the prepared issue template.
26+
You can find all three of them [here](https://github.com/AxonIQ/axon-server-api/issues/new/choose).
27+
28+
## None of the above fit!
29+
30+
If you have encountered a use case which is not a question, nor a feature request, feel free to draft your scenario below.
31+
-->
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: 'Feature request'
3+
about: 'Suggest a feature for the Axon Server API'
4+
title:
5+
type: 'Feature'
6+
---
7+
8+
<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the feature description. -->
9+
10+
### Feature Description
11+
12+
<!--
13+
Please provide a description of the feature you envision.
14+
For example (pseudo-)code snippets showing what it might look like help us understand your suggestion better.
15+
-->
16+
17+
### Current Behaviour
18+
19+
<!-- Please share the current behaviour of the Axon Server API around this topic, if applicable. -->
20+
21+
### Wanted Behaviour
22+
23+
<!-- Please describe the desired outcome through the Axon Server API around the suggested feature. -->
24+
25+
### Possible Workarounds
26+
27+
<!-- If applicable, share any workarounds for the described feature. -->
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 'Enhancement request'
3+
about: 'Suggest an enhancement/change to an existing feature for the Axon Server API'
4+
title:
5+
type: 'Enhancement'
6+
---
7+
8+
<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the enhancement description. -->
9+
10+
### Enhancement Description
11+
12+
<!-- Please provide a description of the enhancement you envision. -->
13+
14+
### Current Behaviour
15+
16+
<!-- Please share the current behaviour of the Axon Server API around this topic, if applicable. -->
17+
18+
### Wanted Behaviour
19+
20+
<!-- Please describe the desired outcome through the Axon Server API around the suggested enhancement. -->
21+
22+
### Possible Workarounds
23+
24+
<!-- If applicable, share any workarounds for the described enhancement. -->
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: 'Bug report'
3+
about: 'Report a bug in the Axon Server API'
4+
title:
5+
type: 'Bug'
6+
---
7+
8+
<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the bug description. -->
9+
10+
### Basic information
11+
12+
* Axon Server version:
13+
* Axon Server API version:
14+
* JDK version:
15+
* Environment details:
16+
* Complete executable reproducer if available (e.g. GitHub Repo):
17+
18+
### Steps to reproduce
19+
20+
<!--
21+
Share all steps to be able to reproduce the bug, ideally based on a reproducer.
22+
Combining this with a description of your setup helps us to figure out what the issue might be.
23+
-->
24+
25+
### Expected behaviour
26+
27+
<!-- Please describe the expected behaviour. -->
28+
29+
### Actual behaviour
30+
31+
<!--
32+
Please describe the actual behaviour as discovered.
33+
If available, provide the entire stack trace, with markdown (```) semantics.
34+
-->
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: 'Documentation change'
3+
about: 'Suggest a documentation change in the Axon Server API'
4+
title:
5+
type: 'Documentation'
6+
---
7+
8+
<!-- Please use markdown (https://guides.github.com/features/mastering-markdown/) semantics throughout the enhancement description. -->
9+
10+
### Suggested Documentation change
11+
12+
<!-- Please provide a description of the documentation change you envision. -->

0 commit comments

Comments
 (0)