Skip to content

Commit ac1a1fa

Browse files
committed
Add issue and PR templates
1 parent d1857af commit ac1a1fa

File tree

5 files changed

+72
-0
lines changed

5 files changed

+72
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug** A clear and concise description of what the bug is.
10+
11+
**Expected alternatives** A clear and concise description of what you expected.
12+
13+
**Screenshots** If applicable, add screenshots to help explain your problem.
14+
15+
**Add references** If you have references to other books, articles, videos, or
16+
even posts somewhere please add URLs here.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this book
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
---
8+
9+
**Please describe your proposal.** A clear and concise description of what do
10+
you want to see in this book.
11+
12+
**Describe alternatives you've considered** A clear and concise description of
13+
any alternative ideas you've considered.
14+
15+
**Add references** If you have references to other books, articles, videos, or
16+
even posts somewhere please add URLs here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Question
3+
about: Please don't open an issue to ask questions
4+
---
5+
6+
Issues on GitHub are intended to be related to problems and feature requests so
7+
we recommend not using this medium to ask them here grin. Thanks for
8+
understanding!
9+
10+
If you have a question, please check out our support groups and channels for
11+
developers community or use `discussions` tab in this repo:
12+
13+
- Discussions: https://github.com/HowProgrammingWorks/Book/discussions
14+
- Channel for HowProgrammingWorks community: https://t.me/HowProgrammingWorks
15+
- Channel for Metaeducation community: https://t.me/metaedu
16+
- Channel for Metarhia community: https://t.me/metarhia

.github/ISSUE_TEMPLATE/spelling.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Spelling
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: spelling
6+
assignees: ''
7+
---
8+
9+
**Describe the problem** How it was and how you think it should be.
10+
11+
**Add link** Please add a URL to the file, certain place in this books or even
12+
to git blame (like this:
13+
https://github.com/HowProgrammingWorks/Book/blame/f47928a14c21d5ac2e2d218d10d10f330972929e/content/Abstract.en.md#L12-L17).
14+
15+
**Screenshots** If applicable, add screenshots to help explain an issue.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!--
2+
Thank you for your pull request.
3+
Check following steps to help us land your changes:
4+
Change [ ] to [x] for completed items.
5+
-->
6+
7+
- [ ] execute `npm run format` before open PR
8+
- [ ] update book index adding content
9+
- [ ] do not regenerate `book.pdf`, it is s subject of separate PR

0 commit comments

Comments
 (0)