Write templates for issues and feature requests.
amtoine opened this issue · comments
Before opening a branch and a PR to implement a feature, or just let the contributors to the repo know the problems, one should open a feature request or an issue respectively.
To guide the user in writing concise, complete and easy to understand issues or feature requests, a template can be very helpful.
Ideas of templates:
A pretty safe way to start is to look at the templates from github itself. The following have been slightly modified.
.github/ISSUE_TEMPLATE/bug_report.md
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''
---
**To Reproduce**
Steps to reproduce the behavior.
**Expected behavior**
A clear and concise description of what you expected to happen.
**What actually happenned**
A clear and concise description of what the bug is.
**Additional context**
Add any other context about the problem here (screeshots if relevant, log file if existing, ...).
.github/ISSUE_TEMPLATE/feature_request.md
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**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.
The discussion is of course open to decide toward what templates to orient the resulting PR! 😋
@amtoine I think now that iScsc/challenges and iScsc/iscsc.fr are growing we should be able to feed this template repo.
I think we kind of need it to especially in iScsc/iscsc.fr because there aren't any for now and the templates might be slightly different than for iScsc/challenges
wow that is an old issue 😆
tbh i do not think there is any urge nor real use in this 😕
Ok no problem I'll just write templates for iScsc/iscsc.fr then!