Skip to content

Commit 92ede11

Browse files
heiskrheiskr
authored
Update issue templates (#1)
* Update issue templates * Update bug_report.md * Update bug_report.md * Update feature_request.md * Update new-course.md * Update new-course.md * Update new-course.md * Update new-course.md
1 parent 22eefb7 commit 92ede11

File tree

3 files changed

+104
-0
lines changed

3 files changed

+104
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[Bug]'
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Device information**
27+
- Type: [e.g. iPhone6]
28+
- OS: [e.g. iOS]
29+
- Browser [e.g. chrome, safari]
30+
- Version [e.g. 22]
31+
32+
**Additional context**
33+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[Feature]'
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/new-course.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: New course
3+
about: Suggest an idea for a new course
4+
title: "[New course] "
5+
labels: new-course
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the learning objectives for the new course**
11+
12+
One or two learning objectives that can be completed in a GitHub repository in 3-5 steps.
13+
14+
Please look through the existing courses and make sure we aren't covering this objective already.
15+
16+
**Describe the steps you will have the learner take**
17+
18+
1. Step 1
19+
2. Step 2
20+
3. Step 3
21+
4. Step 4
22+
5. Step 5 (Usually, merge your pull request)
23+
24+
<!-- Then create your issue. Follow the steps below after you create the issue. -->
25+
26+
**Authoring steps**
27+
28+
- [ ] Read the [Quickstart Guide](https://github.com/githublearn/quickstart-guide) on how to build courses.
29+
- [ ] Start by making the new repository using [template-template](https://github.com/githublearn/template-template).
30+
> This will make the license file, `.gitignore`, and outline your course for you.
31+
> Start in _private_ as you work on your course.
32+
- [ ] Configure the new repository. [🔗](https://github.com/githublearn/quickstart-guide#set-up-your-repository)
33+
- [ ] Settings: Enable the template repository.
34+
- [ ] Settings: Add a 1280×640 social image.
35+
- [ ] Settings: Disable wikis, sponsorships, projects, discussions.
36+
- [ ] Settings: Enable only squash merging.
37+
- [ ] Settings: Enable auto-delete head branches.
38+
- [ ] Code/About: Add a description and tags.
39+
- [ ] Code/About: Disable releases, packages, and environments.
40+
- [ ] Build the README. [🔗](https://github.com/githublearn/quickstart-guide#writing-your-readme)
41+
> Go through the TBDs in the template README file, and follow the Quickstart Guide.
42+
- [ ] Build the steps. [🔗](https://github.com/githublearn/quickstart-guide#writing-your-actions-workflow-files)
43+
> Go through the TBDs in the template workflow files, and follow the Quickstart Guide.
44+
- [ ] Test your course. [🔗](https://github.com/githublearn/quickstart-guide#testing-and-monitoring-your-course)
45+
- [ ] Verify the course works as expected.
46+
- [ ] Review the [Quickstart Guide: Best practices](https://github.com/githublearn/quickstart-guide#best-practices-for-building-courses) to see if you've missed anything.
47+
- [ ] Have someone review the content. @???
48+
- [ ] Get a technical review for the course. @???
49+
- [ ] Publish your course.
50+
- [ ] Enable _public_ on your repository settings, or let learners know the course is ready to take.
51+
- [ ] Share your course with potential learners.

0 commit comments

Comments
 (0)