diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7c76ad116..95d9c8069 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,42 +1,49 @@ --- name: Bug report -about: Create a report to help us improve +about: Report a bug with this project title: 'Bug:' labels: bug assignees: '' --- -> Related issue(s) or PR(s): -> Related project scope(s) (ex: client, CSS, grading, etc...) : -> Related user(s): + + +**Related issue(s) or PR(s):** +- #… + +**Related project scope(s):** … +(e.g. UI, grading, learn-ocaml-client, Teacher-dashboard, partition-view, …) + +**Related user(s):** +- @… ## Bug description -A clear and concise description of what the bug is. + -### To Reproduce +### To reproduce Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Open … +1. Click on … +1. Then … ### Expected behavior -A clear and concise description of what you expected to happen. + + +### Optional screenshots -### Screenshots + -If applicable, add screenshots to document your problem. ## Current configuration - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +* OS name (and version): +* Browser name (and version): +* `learn-ocaml --version`: ## 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 index 8d5facd09..cdfa488ab 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,28 +1,37 @@ --- name: Feature request about: Suggest an idea for this project -title: 'Feat:' +title: 'Feature:' labels: feature assignees: '' --- -> Related issue(s) or PR(s): -> Related project scope(s) (ex: client, CSS, grading, etc...) : -> Related user(s): + + +**Related issue(s) or PR(s):** +- #… + +**Related project scope(s):** … +(e.g. UI, grading, learn-ocaml-client, Teacher-dashboard, partition-view, …) + +**Related user(s):** +- @… ## The problem -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + + + ### Wanted solution -A clear and concise description of what you want to happen. + ### Considered alternatives -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/question.md b/.github/ISSUE_TEMPLATE/question.md index ac5e30648..01c0e2aed 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -7,24 +7,31 @@ assignees: '' --- -> Related issue(s) or PR(s): -> Related project scope(s) (ex: client, CSS, grading, etc...) : -> Related user(s): + + +**Related issue(s) or PR(s):** +- #… + +**Related project scope(s):** … +(e.g. UI, grading, learn-ocaml-client, Teacher-dashboard, partition-view, …) + +**Related user(s):** +- @… ## The question -A clear and concise description of what you want to know. + ### What has already been tested -A clear and concise description of what you have already tried. + ## Current configuration - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +* OS name (and version): +* Browser name (and version): +* `learn-ocaml --version`: ## Additional context -Add any other context or screenshots about the inquiry. + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..b7c24436c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ +* **Kind:** bugfix / enhancement / feature + + + +* Close #… + +### Description + + + +### Checklist + + + +* [ ] Read the [CONTRIBUTING.md](https://github.com/pfitaxel/learn-ocaml/blob/add-contributing.md/CONTRIBUTING.md) guide and: + * [ ] Use [Atomic Commits](https://github.com/pfitaxel/learn-ocaml/blob/add-contributing.md/CONTRIBUTING.md#atomic-commits) so each commit gathers a single logical change + * [ ] Use [Conventional Commits](https://github.com/pfitaxel/learn-ocaml/blob/add-contributing.md/CONTRIBUTING.md#conventional-commits) regarding commit messages (needed by our release toolchain) +* [ ] Add/update [tests](https://github.com/ocaml-sf/learn-ocaml/tree/master/tests#readme) + +* [ ] Add/update [documentation](https://github.com/ocaml-sf/learn-ocaml/tree/master/docs) + +* [ ] … + + + +### Note to maintainers + +* Read [this wiki page](https://github.com/ocaml-sf/learn-ocaml/wiki/Checklist-for-testing-and-merging-a-PR) +* Make sure the PR has a milestone +* Assign yourself before merging