Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #242

Merged
merged 10 commits into from
Jul 5, 2024
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
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 plugin version
- TWW datamodel version
- TWW project file version
- QGIS Version
- OS

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

---

## General information

- Applicant:
- Developer:
- User group referent:
ponceta marked this conversation as resolved.
Show resolved Hide resolved
- Developments referent:
ponceta marked this conversation as resolved.
Show resolved Hide resolved

## Users and administrators needs

### Graphical identity / Logo

_Illustrations if applicable._

### Description of users and administrators feature requirements

_Describe the new feature_

#### General requirements


#### Specific requirements

Necessary features:
### Illustrations of the features and the requirements

_Schemes, screen captures, or any other illustrations._


### Graphical User Interface (GUI)


## Technical analysis and specifications

### Feasibility study

Feasibility, options, alternatives and technical specificities


### Risks and constraints


### Mutualisation
_Mutualisation and possible impacts with other projects_


## Specification and offers ( Developer )
Not shared on Github.
ponceta marked this conversation as resolved.
Show resolved Hide resolved

### Specifications

### Tenders

Not shared on Github.
ponceta marked this conversation as resolved.
Show resolved Hide resolved

### Timeline / deadlines
_Add a detailed timeline_

- [x] 01.09.2024 : First draft
- [ ] 01.10.2024 :
- [ ] 01.11.2024 :


- [ ] Warranty period : to be adressed

### Related softwares versions

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

Public issues links :
- …

Helpdesk issues links :
- …

### Realisation dates

- Tender reception date :
- Tender validation date :

## 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