Skip to content

Commit b0583a6

Browse files
authored
[github] update issues and PR templates (IGNF#78)
* wip: update templates * [github] add a PR template * [doc] update changelog
1 parent 1189bcb commit b0583a6

File tree

4 files changed

+47
-13
lines changed

4 files changed

+47
-13
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,42 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
### Bug
11+
12+
#### Describe the bug
1113
A clear and concise description of what the bug is.
1214

13-
**Type of use (choose between):**
15+
#### Type of use (choose between):
1416
- `service` provided by Road2 (ex. bug with a request from the API simple/1.0.0)
1517
- `administration` of the services provided by Road2
1618
- `other`, please add a helpful description
1719

18-
**Type of bug (choose between):**
20+
#### Type of bug (choose between):
1921
- `request`, for bugs with an API
2022
- `load`, for bugs during the creation of the server
2123
- `checkConfig`, for bugs with this option
2224

23-
**To Reproduce**
25+
#### To Reproduce
2426
Steps to reproduce the behavior:
2527
1. Load server with this configuration
2628
2. Request the server
2729

28-
**Expected behavior**
30+
#### Expected behavior
2931
A clear and concise description of what you expected to happen.
3032

31-
**Environment (please complete the following information):**
33+
#### Environment (please complete the following information):
3234
- OS: [e.g. Debian]
3335
- OS Version: [e.g. 11]
3436
- Node version: [e.g. 16]
3537
- Road2 commit: [sha]
3638

37-
**Configuration:**
39+
#### Configuration:
3840
- the configuration was generated inside the docker image: [eg. yes/no]
3941
- if no, please, provide us the any differences you find useful
4042

41-
**Data:**
43+
#### Data:
4244
Type of data: [eg. osrm, pgrouting, valhalla]
4345
Generation of the data: [eg. docker image of route-graph-generator, other]
4446

45-
**Additional context**
47+
#### Additional context
4648
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,18 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
10+
### Feature
11+
12+
Please, make one issue per asked feature.
13+
14+
#### Is your feature request related to a problem? Please describe.
1115
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1216

13-
**Describe the solution you'd like**
17+
#### Describe the solution you'd like
1418
A clear and concise description of what you want to happen.
1519

16-
**Describe alternatives you've considered**
20+
#### Describe alternatives you've considered
1721
A clear and concise description of any alternative solutions or features you've considered.
1822

19-
**Additional context**
23+
#### Additional context
2024
Add any other context or screenshots about the feature request here.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
### Need
2+
3+
Please, make one PR per feature or fix, and describe the reason of it.
4+
5+
What is appreciated is to link this PR to an existing issue created with a template of this project.
6+
7+
### Tasks
8+
9+
- [ ] Code the feature on a new branch created from develop (see next paragraph)
10+
- [ ] Update tests
11+
- [ ] utest/itest if modification of a classe
12+
- [ ] rtest if modification of an API
13+
- [ ] ctest if modification of a configuration
14+
- [ ] Run tests
15+
- [ ] Inside the docker provided by the project : rtest, ctest, utest, itest
16+
- [ ] Manually if necessary
17+
- [ ] Update the documentation
18+
- [ ] changelog.md
19+
- [ ] documentation directory
20+
- [ ] If possible, rebase your branch from develop
21+
22+
### Code
23+
24+
Please, describe what has been done to achieve this feature or fix.

changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
CHANGED:
66
- GET /admin/1.0.0/services/{service}/projections/{projection} renvoit aussi les paramétres de la projection
77
- Projections were added for France and a file was created to separate them from the world wide projections
8+
- Github issue templates were modified
9+
10+
ADDED:
11+
- A Github PR template was added
812

913
## 2.1.1
1014

0 commit comments

Comments
 (0)