Skip to content

Commit

Permalink
Merge pull request #242 from teksi/add-issue-templates
Browse files Browse the repository at this point in the history
Update issue templates
  • Loading branch information
ponceta authored Jul 5, 2024
2 parents 2ecb050 + 4d7bf16 commit c2897ae
Show file tree
Hide file tree
Showing 4 changed files with 190 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

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

**To Reproduce**
Exact steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

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

**Screenshots / data**
If applicable, add screenshots or data to help explain your problem.

**Desktop (please complete the following information):**
- TWW version
- QGIS Version
- OS

**Additional context**
Add any other context about the problem here.
102 changes: 102 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
name: Feature request
about: Suggest a new feature for this project
title: "[NEW FEATURE REQUEST]"
labels: Feature
assignees: ''

---

## General information
_This document helps to collect information for a TEKSI project definition and afterwards the TEKSI projects specification that are the basis for passing with the new feature process thru the different decision takers.

- Applicant (User. who would like this feature):
- Author (Service provider, who is mandated to write this request):
- Developer (suggested developer(s)):
- TEKSI Code reviewer : _Developer responsible for the code review_


## Users and administrators needs

### Graphical identity / Logo

_Illustrations if applicable._

### Description of users and administrators feature requirements

_Describe the new feature_

### Requirements

_List of requirements_

### Illustrations of the features and the requirements

_Schemes, screen captures, or any other illustrations._

### Graphical User Interface (GUI)

_Provide a mockup of how it should look like_

## Technical analysis and specifications

_Feedbacks from the technical group_

### Feasibility study

_IF required, list the conclusions of the Feasibility study, options, alternatives and technical specificities_

### Risks and constraints

### Mutualisation
_Mutualisation and possible impacts with other projects_

### Specifications

_IF available, link advanced specifications of the features required_

### Timeline / deadlines
_Add a detailed timeline_

- [x] 01.09.2024 : First draft
- [ ] 01.10.2024 :
- [ ] 01.11.2024 :
- [ ] xx.xx.2024 : Presentation and review by User group
- [ ] xx.xx.2024 : Presentation and review by Technical group
- [ ] xx.xx.2024 : TEKSI project definition
- [ ] xx.xx.2024 : Presentation and review by Board (strategic ok)
- [ ] xx.xx.2024 : TEKSI requirements
- [ ] xx.xx.2024 : Presentation and review by Technical group
- [ ] xx.xx.2024 : Presentation and review by Board (technical ok)
- [ ] xx.xx.2024 : Call for offers
- [ ] xx.xx.2024 : ...

### Related softwares versions

- QGIS version:
- Database model version:
- INTERLIS Model version:

### Linked issues :
- [ ] #XXX

## Documentation

Documentation links
- User manual :
- Administrator manual :

## Development and integration

Link and comments from the developer about the product

- Deliverable :
- Recommendations and comments :
- Future prospects :

## Conclusion

Conclusions from applicant, users or admins group

- Conclusion:
- Future prospects:
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/specification_definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Specification definition
about: Suggest a new feature specification definition
title: "[NEW SPECIFICATION DEFINITION]"
labels: Specification
assignees: ''

---

# Objective
_What is expected from the new functionnality/development_

# How it works
_Simple description of how it is supposed to work_

# Configuration
_How it can be configured_

- **Parameters** :

| Field | Type | Mandatory | Example |
|------|-------|--------------|----------|
| id | int4 | Primary key| |

# Other
_Additional informations/requirements_

# Acceptation criteria
| Identifier | Description |
|-----------|-----------------------------------|
| #ISSUE-1 | It works |
| #ISSUE-2 | It works everytime |
| #ISSUE-3 | It works on all systems |
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## General
- [ ] Fix a bug
- [ ] Add a feature
- [ ] Maintenance / sustainability
- [ ] Add Documentation

## Describe your changes

## Screenshots

## Issue ticket number and link

## Checklist before requesting a review
- [ ] I have performed a self-review of my code
- [ ] If it is a core feature, I have added thorough tests.
- [ ] CI Tests are green
- [ ] The documentation is up to date with the proposed change.
- [ ] My work is ready for review

## Checklist before merge
- [ ] A review has been performed
- [ ] Comments are resolved
- [ ] Documentation is ready

0 comments on commit c2897ae

Please sign in to comment.