Skip to content

Commit a3534b9

Browse files
dev: github issue templates
1 parent 00808e7 commit a3534b9

File tree

5 files changed

+82
-0
lines changed

5 files changed

+82
-0
lines changed

.github/ISSUE_TEMPLATE/article.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Article
3+
about: Article content or ideas for a new article
4+
title: Suggested article title
5+
labels: article
6+
assignees: ''
7+
---
8+
9+
**Article title**
10+
A meaningful title for the article, summing up the focus of the article
11+
12+
**Article description or content**
13+
A good article should include
14+
15+
* an introduction to the subject to be covered and why its valuable
16+
* detailed description of the subject, including lots of examples (code, screenshots, videos, etc).
17+
* a summary of the lessons learned in the article
18+
19+
Content should be written in markdown. Images and videos should be shared as publicly accessible links.
20+
21+
**Creative Commons license**
22+
All ideas and content submitted should be copyright free. Submitted content will be used in any Practicalli works and distributed under a Creative Commons license to ensure that content remains freely available.

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: bug
3+
about: Correction for a published blog article
4+
title: 'fix(section): '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the correction**
10+
11+
Corrections for any published content, including descriptions, images and code.
12+
13+
Please give clear and concise description of what should be corrected, why you consider the existing content incorrect and any references that support a change.
14+
15+
Corrections should be limited to a specific article or page.
16+
17+
If you only wish to add content, use the [article issue template](https://github.com/practicalli/practicalli-github-io/issues/new?labels=article&template=article.md)
18+
19+
**Mention the project maintainers**
20+
21+
@practicalli-johnny
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: enhancement
3+
about: Add content to a published article or page
4+
title: 'enhance: '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
Enhance an published article or page, including descriptions, images and code.
10+
11+
**Describe the correction**
12+
13+
Please give clear and concise description of the content to be enhanced, preferably for a specific article or page. Add or link to any content should be used to update the published article.
14+
15+
Use the [bug issue](https://github.com/practicalli/blog-content/issues/new?labels=bug&template=bug.md) if you find any published content that has factual errors.
16+
17+
**Mention the project maintainers**
18+
19+
@practicalli-johnny
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: website-design
3+
about: issues and improvements to usability (UX) and graphic design of the website
4+
title: 'UX: '
5+
labels: website-design
6+
assignees: ''
7+
---
8+
9+
**Describe the issue or improvement**
10+
11+
A clear and concise description of the change you would like to make to the website design.
12+
13+
Please link to any images showing proposed changes to the design if relevant.
14+
15+
Please discuss changes in [Website Design (UX) GitHub discussions](https://github.com/orgs/practicalli/discussions/categories/website-design-ux) before investing time in a change.
16+
17+
## Mention project maintainer for faster response
18+
19+
@practicalli-johnny

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- dev: stale issue & pr scheduled check (monthly)
1616
- intro: lexers for markdown code block syntax highlights in writing tips
1717
- intro: warning not to embed file from same repository in code block
18+
- dev: github issue templates
1819

1920
## Changed
2021
- mkdocs: correct github url for repo and edit link

0 commit comments

Comments
 (0)