diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..b1976616d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..7151b5dcd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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: diff --git a/.github/ISSUE_TEMPLATE/specification_definition.md b/.github/ISSUE_TEMPLATE/specification_definition.md new file mode 100644 index 000000000..154da3503 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/specification_definition.md @@ -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 | diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request.md b/.github/PULL_REQUEST_TEMPLATE/pull_request.md new file mode 100644 index 000000000..ce6a2059c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request.md @@ -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