Skip to content

Commit

Permalink
Added initial GitHub issues templates (#146)
Browse files Browse the repository at this point in the history
  • Loading branch information
Nusnus authored Jan 6, 2024
1 parent 8372ccc commit ca5a79d
Show file tree
Hide file tree
Showing 4 changed files with 238 additions and 0 deletions.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug-Report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
name: Bug Report
about: Is something wrong with Pytest Celery?
title: ''
labels: 'bug'
assignees: ''

---

<!--
Please fill this template entirely and do not erase parts of it.
We reserve the right to close without a response
bug reports which are incomplete.
-->
# Checklist
<!--
To check an item on the list replace [ ] with [x].
-->
- [ ] I have verified that the issue exists against the `main` branch of Pytest Celery.
- [ ] This has already been asked to the [discussions forum](https://github.com/celery/pytest-celery/discussions) first.
- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?q=is%3Aissue+label%3A%22bug%22+-label%3A%22documentation%22)
for similar or identical bug reports.
- [ ] 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)
for existing proposed fixes.
- [ ] I have checked the [commit log](https://github.com/celery/pytest-celery/commits/main)
to find out if the bug was already fixed in the main branch.
- [ ] I have included all related issues and possible duplicate issues
in this issue (If there are none, check this box anyway).

## Mandatory Debugging Information

- [ ] I have verified that the issue exists against the `main` branch of Celery.
- [ ] I have included the contents of ``pip freeze`` in the issue.
- [ ] I have included all the versions of all the external dependencies required
to reproduce this bug.

## Related Issues and Possible Duplicates
<!--
Please make sure to search and mention any related issues
or possible duplicates to this issue as requested by the checklist above.
This may or may not include issues in other repositories that the Celery project
maintains or other repositories that are dependencies of Celery.
If you don't know how to mention issues, please refer to Github's documentation
on the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests
-->

#### Related Issues

- None

#### Possible Duplicates

- None

## Environment & Settings

# Steps to Reproduce

## Required Dependencies
<!-- Please fill the required dependencies to reproduce this issue -->
None

## Minimally Reproducible Test Case
<!--
Please provide a reproducible test case.
We prefer submitting test cases in the form of a PR to our integration test suite.
If you can provide one, please mention the PR number below.
If not, please attach the most minimal code example required to reproduce the issue below.
If the test case is too large, please include a link to a gist or a repository below.
-->

<details>
<p>

```python
```

</p>
</details>

# Expected Behavior
<!-- Describe in detail what you expect to happen -->

# Actual Behavior
<!--
Describe in detail what actually happened.
Please include a backtrace and surround it with triple backticks (```).
-->
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/Documentation-Bug-Report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: Documentation Bug Report
about: Is something wrong with our documentation?
title: ''
labels: 'documentation'
assignees: ''

---

<!--
Please fill this template entirely and do not erase parts of it.
We reserve the right to close without a response
bug reports which are incomplete.
-->
# Checklist
<!--
To check an item on the list replace [ ] with [x].
-->

- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22documentation%22+)
for similar or identical bug reports.
- [ ] I have checked the [pull requests list](https://github.com/celery/pytest-celery/pulls?q=is%3Apr+label%3A%22documentation%22)
for existing proposed fixes.
- [ ] I have checked the [commit log](https://github.com/celery/pytest-celery/commits/main)
to find out if the bug was already fixed in the main branch.
- [ ] I have included all related issues and possible duplicate issues in this issue
(If there are none, check this box anyway).

## Related Issues and Possible Duplicates
<!--
Please make sure to search and mention any related issues
or possible duplicates to this issue as requested by the checklist above.
This may or may not include issues in other repositories that the Celery project
maintains or other repositories that are dependencies of Celery.
If you don't know how to mention issues, please refer to Github's documentation
on the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests
-->

#### Related Issues

- None

#### Possible Duplicates

- None

# Description
<!--
Please describe what's missing or incorrect about our documentation.
Include links and/or screenshots which will aid us to resolve the issue.
-->

# Suggestions
<!-- Please provide us suggestions for how to fix the documentation -->
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature-Request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
name: Feature Request
about: Do you need a new feature?
title: ''
labels: 'feature'
assignees: ''

---

<!--
Please fill this template entirely and do not erase parts of it.
We reserve the right to close without a response
feature requests which are incomplete.
-->
# Checklist
<!--
To check an item on the list replace [ ] with [x].
-->

- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22feature%22+)
for similar or identical feature requests.
- [ ] 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+)
for existing proposed implementations of this feature.
- [ ] I have checked the [commit log](https://github.com/celery/pytest-celery/commits/main)
to find out if the same feature was already implemented in the
main branch.
- [ ] I have included all related issues and possible duplicate issues in this issue
(If there are none, check this box anyway).

## Related Issues and Possible Duplicates
<!--
Please make sure to search and mention any related issues
or possible duplicates to this issue as requested by the checklist above.
This may or may not include issues in other repositories that the Celery project
maintains or other repositories that are dependencies of Celery.
If you don't know how to mention issues, please refer to Github's documentation
on the subject: https://help.github.com/en/articles/autolinked-references-and-urls#issues-and-pull-requests
-->

#### Related Issues

- None

#### Possible Duplicates

- None

# Brief Summary
<!--
Please include a brief summary of what the feature does
and why it is needed.
-->

# Design

## Proposed Behavior
<!--
Please describe in detail how this feature is going to behave.
Describe what happens in case of failures as well if applicable.
-->

## Proposed UI/UX
<!--
Please provide your ideas for the API, CLI options,
configuration key names etc. that will be introduced for this feature.
-->

## Diagrams
<!--
Please include any diagrams that might be relevant
to the implementation of this feature such as:
* Class Diagrams
* Sequence Diagrams
* Activity Diagrams
You can drag and drop images into the text box to attach them to this issue.
-->
N/A

## Alternatives
<!--
If you have considered any alternative implementations
describe them in detail below.
-->
None
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Celery Issue Tracker
url: https://github.com/celery/celery/issues/
about: If this issue only involves Celery, please open a new issue there.

0 comments on commit ca5a79d

Please sign in to comment.