Skip to content

Commit ca5a79d

Browse files
authored
Added initial GitHub issues templates (celery#146)
1 parent 8372ccc commit ca5a79d

File tree

4 files changed

+238
-0
lines changed

4 files changed

+238
-0
lines changed

.github/ISSUE_TEMPLATE/Bug-Report.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
name: Bug Report
3+
about: Is something wrong with Pytest Celery?
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill this template entirely and do not erase parts of it.
12+
We reserve the right to close without a response
13+
bug reports which are incomplete.
14+
-->
15+
# Checklist
16+
<!--
17+
To check an item on the list replace [ ] with [x].
18+
-->
19+
- [ ] I have verified that the issue exists against the `main` branch of Pytest Celery.
20+
- [ ] This has already been asked to the [discussions forum](https://github.com/celery/pytest-celery/discussions) first.
21+
- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?q=is%3Aissue+label%3A%22bug%22+-label%3A%22documentation%22)
22+
for similar or identical bug reports.
23+
- [ ] I have checked the [pull requests list](https://github.com/celery/pytest-celery/pulls?q=is%3Apr+label%3A%22bug%22+-label%3A%22documentation%22)
24+
for existing proposed fixes.
25+
- [ ] I have checked the [commit log](https://github.com/celery/pytest-celery/commits/main)
26+
to find out if the bug was already fixed in the main branch.
27+
- [ ] I have included all related issues and possible duplicate issues
28+
in this issue (If there are none, check this box anyway).
29+
30+
## Mandatory Debugging Information
31+
32+
- [ ] I have verified that the issue exists against the `main` branch of Celery.
33+
- [ ] I have included the contents of ``pip freeze`` in the issue.
34+
- [ ] I have included all the versions of all the external dependencies required
35+
to reproduce this bug.
36+
37+
## Related Issues and Possible Duplicates
38+
<!--
39+
Please make sure to search and mention any related issues
40+
or possible duplicates to this issue as requested by the checklist above.
41+
42+
This may or may not include issues in other repositories that the Celery project
43+
maintains or other repositories that are dependencies of Celery.
44+
45+
If you don't know how to mention issues, please refer to Github's documentation
46+
on the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests
47+
-->
48+
49+
#### Related Issues
50+
51+
- None
52+
53+
#### Possible Duplicates
54+
55+
- None
56+
57+
## Environment & Settings
58+
59+
# Steps to Reproduce
60+
61+
## Required Dependencies
62+
<!-- Please fill the required dependencies to reproduce this issue -->
63+
None
64+
65+
## Minimally Reproducible Test Case
66+
<!--
67+
Please provide a reproducible test case.
68+
69+
We prefer submitting test cases in the form of a PR to our integration test suite.
70+
If you can provide one, please mention the PR number below.
71+
If not, please attach the most minimal code example required to reproduce the issue below.
72+
If the test case is too large, please include a link to a gist or a repository below.
73+
-->
74+
75+
<details>
76+
<p>
77+
78+
```python
79+
```
80+
81+
</p>
82+
</details>
83+
84+
# Expected Behavior
85+
<!-- Describe in detail what you expect to happen -->
86+
87+
# Actual Behavior
88+
<!--
89+
Describe in detail what actually happened.
90+
Please include a backtrace and surround it with triple backticks (```).
91+
-->
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Documentation Bug Report
3+
about: Is something wrong with our documentation?
4+
title: ''
5+
labels: 'documentation'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill this template entirely and do not erase parts of it.
12+
We reserve the right to close without a response
13+
bug reports which are incomplete.
14+
-->
15+
# Checklist
16+
<!--
17+
To check an item on the list replace [ ] with [x].
18+
-->
19+
20+
- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22documentation%22+)
21+
for similar or identical bug reports.
22+
- [ ] I have checked the [pull requests list](https://github.com/celery/pytest-celery/pulls?q=is%3Apr+label%3A%22documentation%22)
23+
for existing proposed fixes.
24+
- [ ] I have checked the [commit log](https://github.com/celery/pytest-celery/commits/main)
25+
to find out if the bug was already fixed in the main branch.
26+
- [ ] I have included all related issues and possible duplicate issues in this issue
27+
(If there are none, check this box anyway).
28+
29+
## Related Issues and Possible Duplicates
30+
<!--
31+
Please make sure to search and mention any related issues
32+
or possible duplicates to this issue as requested by the checklist above.
33+
34+
This may or may not include issues in other repositories that the Celery project
35+
maintains or other repositories that are dependencies of Celery.
36+
37+
If you don't know how to mention issues, please refer to Github's documentation
38+
on the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests
39+
-->
40+
41+
#### Related Issues
42+
43+
- None
44+
45+
#### Possible Duplicates
46+
47+
- None
48+
49+
# Description
50+
<!--
51+
Please describe what's missing or incorrect about our documentation.
52+
Include links and/or screenshots which will aid us to resolve the issue.
53+
-->
54+
55+
# Suggestions
56+
<!-- Please provide us suggestions for how to fix the documentation -->
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
name: Feature Request
3+
about: Do you need a new feature?
4+
title: ''
5+
labels: 'feature'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill this template entirely and do not erase parts of it.
12+
We reserve the right to close without a response
13+
feature requests which are incomplete.
14+
-->
15+
# Checklist
16+
<!--
17+
To check an item on the list replace [ ] with [x].
18+
-->
19+
20+
- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22feature%22+)
21+
for similar or identical feature requests.
22+
- [ ] I have checked the [pull requests list](https://github.com/celery/pytest-celery/pulls?utf8=%E2%9C%93&q=is%3Apr+label%3A%22feature%22+)
23+
for existing proposed implementations of this feature.
24+
- [ ] I have checked the [commit log](https://github.com/celery/pytest-celery/commits/main)
25+
to find out if the same feature was already implemented in the
26+
main branch.
27+
- [ ] I have included all related issues and possible duplicate issues in this issue
28+
(If there are none, check this box anyway).
29+
30+
## Related Issues and Possible Duplicates
31+
<!--
32+
Please make sure to search and mention any related issues
33+
or possible duplicates to this issue as requested by the checklist above.
34+
35+
This may or may not include issues in other repositories that the Celery project
36+
maintains or other repositories that are dependencies of Celery.
37+
38+
If you don't know how to mention issues, please refer to Github's documentation
39+
on the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests
40+
-->
41+
42+
#### Related Issues
43+
44+
- None
45+
46+
#### Possible Duplicates
47+
48+
- None
49+
50+
# Brief Summary
51+
<!--
52+
Please include a brief summary of what the feature does
53+
and why it is needed.
54+
-->
55+
56+
# Design
57+
58+
## Proposed Behavior
59+
<!--
60+
Please describe in detail how this feature is going to behave.
61+
Describe what happens in case of failures as well if applicable.
62+
-->
63+
64+
## Proposed UI/UX
65+
<!--
66+
Please provide your ideas for the API, CLI options,
67+
configuration key names etc. that will be introduced for this feature.
68+
-->
69+
70+
## Diagrams
71+
<!--
72+
Please include any diagrams that might be relevant
73+
to the implementation of this feature such as:
74+
* Class Diagrams
75+
* Sequence Diagrams
76+
* Activity Diagrams
77+
You can drag and drop images into the text box to attach them to this issue.
78+
-->
79+
N/A
80+
81+
## Alternatives
82+
<!--
83+
If you have considered any alternative implementations
84+
describe them in detail below.
85+
-->
86+
None

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Celery Issue Tracker
4+
url: https://github.com/celery/celery/issues/
5+
about: If this issue only involves Celery, please open a new issue there.

0 commit comments

Comments
 (0)