Skip to content

Commit a5886d1

Browse files
tbouffardtbouffard
authored
docs: improve the issue templates (#3148)
Enforce the order of the templates. Provide links to external resources in the issue chooser. The "about" entry is taken from the description put in the page of the Process Analytics website. In the bug template, provide more guidance for the reproduction steps.
1 parent e3f48eb commit a5886d1

7 files changed

Lines changed: 98 additions & 47 deletions

File tree

‎.github/ISSUE_TEMPLATE/01-bug_report.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
Provide a clear and concise description of what the bug is.
12+
13+
14+
### To Reproduce
15+
<!-- Fill the reproduction steps -->
16+
Steps to reproduce the behavior:
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
<!-- Adapt the following text to your needs -->
23+
Please provide a BPMN diagram that reproduces the problem: "attach here the BPMN diagram"
24+
25+
If possible, provide a code snippet that reproduces the problem: "attach here the code snippet"
26+
Or a link to a repository that reproduces the problem: "provide the link here"
27+
28+
The https://github.com/process-analytics/bpmn-visualization-examples repository contains examples that can be used to reproduce the problem.
29+
30+
31+
### Expected behavior
32+
Provide a clear and concise description of what you expected to happen.
33+
34+
<!--
35+
For BPMN rendering problems, please test your BPMN diagram with other BPMN vendors.
36+
For example, you can use:
37+
- the `bpmn-js` demo: https://demo.bpmn.io/new)
38+
- the `bpmn-visualization` example comparing the rendering with `bpmn-js`: https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/misc/compare-with-bpmn-js/index.html.
39+
In this URL, you can replace `master` by a specific tag (for example v0.43.0) to check a specific version of `bpmn-visualization`.
40+
41+
Be aware that `bpmn-visualization` and `bpmn-js` have different rendering behavior, in particular for:
42+
- label activity: https://github.com/process-analytics/bpmn-visualization-js/issues/2253
43+
- default label position: https://github.com/process-analytics/bpmn-visualization-js/issues/2306
44+
- fill color: https://github.com/process-analytics/bpmn-visualization-js/issues/2590#issuecomment-1486053921
45+
46+
Here are some examples of good reports:
47+
- https://github.com/process-analytics/bpmn-visualization-js/issues/2857#issuecomment-1722447316
48+
- https://github.com/process-analytics/bpmn-visualization-js/issues/2590#issuecomment-1486053921
49+
50+
-->
51+
52+
53+
### Screenshots
54+
If applicable, add screenshots or videos to help explain your problem.
55+
56+
57+
### Environment
58+
- Desktop or mobile:
59+
- OS and version: [e.g. iOS 14.1]
60+
- Browser and version: [e.g. chrome 118, safari 15]
61+
- Node/npm version (if applicable):
62+
- Used frameworks (if applicable):
63+
64+
65+
### Additional context
66+
Add any other context about the problem here.
67+

.github/ISSUE_TEMPLATE/feature_request.md renamed to .github/ISSUE_TEMPLATE/02-feature_request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ assignees: ''
88
---
99

1010
### Is your feature request related to a problem? Please describe.
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1212

1313
### Describe the solution you'd like
14-
A clear and concise description of what you want to happen.
14+
Provide a clear and concise description of what you want to happen.
1515

1616
### Describe alternatives you've considered
17-
A clear and concise description of any alternative solutions or features you've considered.
17+
Provide a clear and concise description of any alternative solutions or features you've considered.
1818

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

.github/ISSUE_TEMPLATE/question.md renamed to .github/ISSUE_TEMPLATE/03-question.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Question
33
about: Ask any question about the project
4-
title: "[QUESTION]"
4+
title: "[QUESTION] "
55
labels: question
66
assignees: ''
77

.github/ISSUE_TEMPLATE/other.md renamed to .github/ISSUE_TEMPLATE/04-other.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ assignees: ''
77

88
---
99

10-
Please use this template only if your issue doesn't match a Bug Report, Feature Request or Question?
10+
Please use this template only if your issue doesn't match a Bug Report, Feature Request or Question.

‎.github/ISSUE_TEMPLATE/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Issue Templates
2+
3+
## Documentation
4+
5+
[Syntax for issue forms (the top level properties)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)
6+
7+
[Syntax for GitHub's form schema (the form body)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)
8+
9+
[Configuring the template chooser (config.yml)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)
10+
11+
https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
12+
13+
14+
## Template Chooser Sorting
15+
16+
The templates are sorted in the template chooser based on the filename, not on the form name. This is why we have prefixed the filenames with numbers.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
11
# see https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
22
blank_issues_enabled: false
3+
contact_links:
4+
- name: "Getting Started with bpmn-visualization" article
5+
url: https://medium.com/@process-analytics/getting-started-with-bpmn-visualization-a54fbafae2df
6+
about: A getting started tutorial to bpmn-visualization using an online monitoring scenario.
7+
- name: "All you need to know about styling BPMN elements" article
8+
url: https://medium.com/@process-analytics/bpmn-visualization-all-you-need-to-know-about-styling-bpmn-elements-24289154c16c
9+
about: Diving into bpmn-visualization Typescript library, we focus on style management, with resources for beginners and advanced usage scenarios.
10+
- name: `bpmn-visualization` examples repository
11+
url: https://github.com/process-analytics/bpmn-visualization-examples/
12+
about: Examples of use of the `bpmn-visualization` library.

0 commit comments

Comments
 (0)
⚡