Skip to content

Commit

Permalink
Add issue templates (#112)
Browse files Browse the repository at this point in the history
* Add a github workflow that prevents PRs to main that is not comming from dev (#92) (#93)

* Create feature request template

* improve documentation template

* update feature request template

---------

Co-authored-by: AlvaroCubi <[email protected]>
  • Loading branch information
alexvalentine94 and AlvaroCubi authored May 3, 2024
1 parent 1970ce7 commit 27293c1
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[Feature request] - title of the issue"
labels: enhancement
assignees: ''

---

# Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.

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

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

# Additional context
Add any other context or screenshots about the feature request here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/improve_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Improve documentation
about: Help us improve our documentation
title: "[DOC] - title of the issue"
labels: documentation
assignees: ''

---

# What were you looking for
Please try to describe in a concise way which kind of information you were looking for and where were you looking.

# Is the information available in the doc but not where you would expect?
let us know if you ended up finding the information you were looking for in another (unexpected) section of the doc.

# Is information completely lacking or partial?
please specify if you are asking for better explanation/clarification of the text or if the information is completely lacking.

# Where would you insert the missing information?
describe here where you would put the information.

# Additional context
you can use this space to give any other additional information that you think would be useful to solve the issue.

0 comments on commit 27293c1

Please sign in to comment.