Skip to content

Commit 70c29d7

Browse files
paduszykpaduszyk
committed
docs: add PR/issue forms and templates
1 parent f7f1675 commit 70c29d7

File tree

6 files changed

+180
-0
lines changed

6 files changed

+180
-0
lines changed

‎.github/ISSUE_TEMPLATE/1-bug-report.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Bug Report
2+
3+
description: >-
4+
Report a bug.
5+
6+
body:
7+
- type: textarea
8+
id: versions
9+
attributes:
10+
label: Versions
11+
description: >-
12+
Provide versions for all environment components related to the issue.
13+
value: |
14+
* Package: -
15+
* Python: -
16+
* Django: -
17+
* OS / Platform: -
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: Description
22+
description: >-
23+
Describe the unexpected behavior related to the issue.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: reproduction
28+
attributes:
29+
label: Reproduction
30+
description: >-
31+
Provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) demonstrating the issue.
32+
validations:
33+
required: true
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Terms
38+
description: >-
39+
Before submitting the issue, confirm the following:
40+
options:
41+
- label: >-
42+
I have read and followed the project's
43+
[Code of Conduct](https://github.com/paduszyk/django-management-commands/blob/main/docs/CODE_OF_CONDUCT.md) and
44+
[Contributing Guide](https://github.com/paduszyk/django-management-commands/blob/main/docs/CONTRIBUTING.md).
45+
required: true
46+
- label: >-
47+
I have checked that this issue isn't a duplicate.
48+
required: true

‎.github/ISSUE_TEMPLATE/2-feature-request.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Feature Request
2+
3+
description: >-
4+
Propose new functionality or an enhancement to existing features.
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: >-
12+
Describe the feature you would like to add or update.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: solution
17+
attributes:
18+
label: Suggested Solution
19+
description: >-
20+
Share your ideas on how to implement the proposed changes.
21+
validations:
22+
required: true
23+
- type: checkboxes
24+
id: terms
25+
attributes:
26+
label: Terms
27+
description: >-
28+
Before submitting the issue, please confirm the following:
29+
options:
30+
- label: >-
31+
I have read and followed the project's
32+
[Code of Conduct](https://github.com/paduszyk/django-management-commands/blob/main/docs/CODE_OF_CONDUCT.md) and
33+
[Contributing Guide](https://github.com/paduszyk/django-management-commands/blob/main/docs/CONTRIBUTING.md).
34+
required: true
35+
- label: >-
36+
I have checked that this issue is not a duplicate.
37+
required: true

‎.github/ISSUE_TEMPLATE/3-documentation.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation Update
2+
3+
description: >-
4+
Suggest improvements for the documentation.
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: >-
12+
Describe the documentation improvements you would like to suggest.
13+
validations:
14+
required: true
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Terms
19+
description: >-
20+
Before submitting the issue, please confirm the following:
21+
options:
22+
- label: >-
23+
I have read and followed the project's
24+
[Code of Conduct](https://github.com/paduszyk/django-management-commands/blob/main/docs/CODE_OF_CONDUCT.md) and
25+
[Contributing Guide](https://github.com/paduszyk/django-management-commands/blob/main/docs/CONTRIBUTING.md).
26+
required: true
27+
- label: >-
28+
I have checked that this issue is not a duplicate.
29+
required: true

‎.github/ISSUE_TEMPLATE/4-refactoring-performance.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Refactoring / Performance Improvement
2+
3+
description: >-
4+
Propose code refactoring or performance improvements.
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: >-
12+
Describe the refactoring or performance improvements you would like to suggest.
13+
validations:
14+
required: true
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Terms
19+
description: >-
20+
Before submitting the issue, please confirm the following:
21+
options:
22+
- label: >-
23+
I have read and followed the project's
24+
[Code of Conduct](https://github.com/paduszyk/django-management-commands/blob/main/docs/CODE_OF_CONDUCT.md) and
25+
[Contributing Guide](https://github.com/paduszyk/django-management-commands/blob/main/docs/CONTRIBUTING.md).
26+
required: true
27+
- label: >-
28+
I have checked that this issue is not a duplicate.
29+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: Code of Conduct
5+
url: https://github.com/paduszyk/django-management-commands/blob/main/docs/CODE_OF_CONDUCT.md
6+
about: >-
7+
All contributors must adhere to our Code of Conduct.
8+
- name: Contributing Guide
9+
url: https://github.com/paduszyk/django-management-commands/blob/main/docs/CONTRIBUTING.md
10+
about: >-
11+
Please read this guide before making any contributions.
12+
- name: GitHub Community Guidelines
13+
url: https://docs.github.com/en/site-policy/github-terms/github-community-guidelines
14+
about: >-
15+
This article outlines GitHub's rules for user behavior and community conduct.

‎.github/pull_request_template.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Linked Issues
2+
3+
<!-- Use closing keywords if this PR may resolve an existing issue. -->
4+
5+
## Description
6+
7+
<!-- Provide a concise description of the introduced changes. -->
8+
9+
## Checklist
10+
11+
<!-- Remove items that are not applicable. -->
12+
13+
- [ ] I have read and followed the project's [Code of Conduct][code-of-conduct] and [Contributing Guide][contributing].
14+
- [ ] I have checked that similar PRs have not been created before.
15+
- [ ] I have performed a self-review of my code.
16+
- [ ] I have added tests covering my fix or feature implementation.
17+
- [ ] I have made corresponding changes to the documentation.
18+
- [ ] New and existing unit tests pass locally with my changes.
19+
- [ ] Any dependent changes have been merged and published in downstream modules.
20+
21+
[code-of-conduct]: https://github.com/paduszyk/django-management-commands/blob/main/docs/CODE_OF_CONDUCT.md
22+
[contributing]: https://github.com/paduszyk/django-management-commands/blob/main/docs/CONTRIBUTING.md

0 commit comments

Comments
 (0)