Skip to content

docs: issue and PR templates (#55)#114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ulises-jeremias merged 1 commit into from
Jul 16, 2026
Merged

docs: issue and PR templates (#55) #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
name: "Bug Report"
description: Report a bug
title: "(short issue description)"
labels: [bug]
body:
- type: textarea
attributes:
label: Description
description: What is the problem?
validations:
required: true
- type: textarea
attributes:
label: Environment
description: You can use `create-awesome-python-app --info` to fill this section.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: General Question
url: https://github.com/Create-Python-App/create-python-app/discussions
about: Please ask and answer questions here.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
name: Documentation Issue
description: Report a docs problem
labels: [documentation]
body:
- type: textarea
attributes:
label: Description
validations:
required: true
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
name: Feature Request
description: Suggest an idea
title: "(short issue description)"
labels: [enhancement]
body:
- type: textarea
attributes:
label: Problem
validations:
required: true
- type: textarea
attributes:
label: Solution
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
## Summary

Check failure on line 1 in .github/PULL_REQUEST_TEMPLATE.md

View workflow job for this annotation

GitHub Actions/ markdownlint

Headings should be surrounded by blank lines 

.github/PULL_REQUEST_TEMPLATE.md:1 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Summary"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md022.md
-

Check failure on line 2 in .github/PULL_REQUEST_TEMPLATE.md

View workflow job for this annotation

GitHub Actions/ markdownlint

Lists should be surrounded by blank lines 

.github/PULL_REQUEST_TEMPLATE.md:2 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "-"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md032.md

## Test plan

Check failure on line 4 in .github/PULL_REQUEST_TEMPLATE.md

View workflow job for this annotation

GitHub Actions/ markdownlint

Headings should be surrounded by blank lines 

.github/PULL_REQUEST_TEMPLATE.md:4 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Test plan"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md022.md
- [ ] `make test`

Check failure on line 5 in .github/PULL_REQUEST_TEMPLATE.md

View workflow job for this annotation

GitHub Actions/ markdownlint

Lists should be surrounded by blank lines 

.github/PULL_REQUEST_TEMPLATE.md:5 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] `make test`"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md032.md
- [ ] `make lint`
- [ ] `make typecheck`

Closes #
Loading