From 27293c16517e5dd920319fbac58173ad67dd6b7a Mon Sep 17 00:00:00 2001 From: Alex Valentine <40658938+alexvalentine94@users.noreply.github.com> Date: Fri, 3 May 2024 13:28:12 +0100 Subject: [PATCH] Add issue templates (#112) * 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 <55387701+AlvaroCubi@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++ .../ISSUE_TEMPLATE/improve_documentation.md | 23 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/improve_documentation.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..898e67a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/improve_documentation.md b/.github/ISSUE_TEMPLATE/improve_documentation.md new file mode 100644 index 00000000..8505783b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve_documentation.md @@ -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.