Skip to content

Commit

Permalink
workflow(issues): update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
AnthonyGlt committed May 3, 2024
1 parent d3a317b commit f8d3d8c
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug :bug:'
assignees: ''

---

<!--- Provide a general summary of the issue in the Title above -->

## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Browser Name and version:
* Operating System and version (desktop or mobile):
* Link to your project:

## Context
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
<!--- How has this bug affected you? -->
<!--- If you have errors or a stacktrace in the console, here is a good place to put it. -->
<!--- Please consider using a pastebin service or create a gist.-->
<!--- Some screenshots are always greatly appreciated here! -->


## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Expected Behavior
<!--- Tell us what you think should happen -->

## Actual Behavior
<!--- Tell us what happens instead of the expected behavior -->

## Possible Cause/Fix/Solution
<!--- Not obligatory, but suggest a cause or reason for the bug if relevant, -->
<!--- or ideas how to implement the addition or change -->
<!--- In any case, please consider opening a PR and become an iTowns developer! -->
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Proposal request
about: Suggest an idea for this project
title: ''
labels: 'proposal :+1:'
assignees: ''

---


<!--- /!\ IMPORTANT /!\ ONE proposal for ONE and ONLY ONE feature -->



<!--- Provide a general summary of the proposal in the Title above -->

This issue is a **feature proposal**. Feel free to upvote (with :+1: ), comment and provide your use-cases if you're interested by this feature.

## Context
<!--- A description of the feature and why this feature could be interesting to implement in iTowns! -->
<!--- Current state of iTowns vs. state after implementation -->


## Description of the proposal
<!--- What would this feature looks like in iTowns ? -->
<!--- Please tell us what you are trying to accomplish -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
<!--- Could be screenshot of the feature implemented somewhere else or results/stats/poc showing the potential result -->

### Identified use-cases
<!--- Define in which context this feature could be useful for the user -->

## Implementation

### Functional Implementation
<!--- Things that should be done in iTowns to implement this feature -->

### Technical Implementation _(optional)_
<!--- Describe the proposed implementation (PR, pseudo-code and/or diagrams) -->

## Potential Problems
<!--- Things that could be problematic with this feature or its implementation -->

## Potential Solutions
<!--- Things that could be done to avoid the mentioned problems -->

## Documentation
<!--- Links or explanation behind the logic of implementation -->
<!--- Could be used to implement this feature -->
<!--- Git Branches / Issues -->

0 comments on commit f8d3d8c

Please sign in to comment.