Skip to content

Commit

Permalink
[github] update issues and PR templates (IGNF#78)
Browse files Browse the repository at this point in the history
* wip: update templates

* [github] add a PR template

* [doc] update changelog
  • Loading branch information
lgrd authored May 9, 2023
1 parent 1189bcb commit b0583a6
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 13 deletions.
20 changes: 11 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,42 @@ assignees: ''

---

**Describe the bug**
### Bug

#### Describe the bug
A clear and concise description of what the bug is.

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

**Type of bug (choose between):**
#### Type of bug (choose between):
- `request`, for bugs with an API
- `load`, for bugs during the creation of the server
- `checkConfig`, for bugs with this option

**To Reproduce**
#### To Reproduce
Steps to reproduce the behavior:
1. Load server with this configuration
2. Request the server

**Expected behavior**
#### Expected behavior
A clear and concise description of what you expected to happen.

**Environment (please complete the following information):**
#### Environment (please complete the following information):
- OS: [e.g. Debian]
- OS Version: [e.g. 11]
- Node version: [e.g. 16]
- Road2 commit: [sha]

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

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

**Additional context**
#### Additional context
Add any other context about the problem here.
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@ assignees: ''

---

**Is your feature request related to a problem? Please describe.**
### Feature

Please, make one issue per asked feature.

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

**Describe the solution you'd like**
#### Describe the solution you'd like
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
#### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
#### Additional context
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### Need

Please, make one PR per feature or fix, and describe the reason of it.

What is appreciated is to link this PR to an existing issue created with a template of this project.

### Tasks

- [ ] Code the feature on a new branch created from develop (see next paragraph)
- [ ] Update tests
- [ ] utest/itest if modification of a classe
- [ ] rtest if modification of an API
- [ ] ctest if modification of a configuration
- [ ] Run tests
- [ ] Inside the docker provided by the project : rtest, ctest, utest, itest
- [ ] Manually if necessary
- [ ] Update the documentation
- [ ] changelog.md
- [ ] documentation directory
- [ ] If possible, rebase your branch from develop

### Code

Please, describe what has been done to achieve this feature or fix.
4 changes: 4 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
CHANGED:
- GET /admin/1.0.0/services/{service}/projections/{projection} renvoit aussi les paramétres de la projection
- Projections were added for France and a file was created to separate them from the world wide projections
- Github issue templates were modified

ADDED:
- A Github PR template was added

## 2.1.1

Expand Down

0 comments on commit b0583a6

Please sign in to comment.