Skip to content
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.

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

Draft issue and PR templates. #32

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_form.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Bug Report Form
description: Report a bug or a similiar issue.
labels:
- needs:triage
title: "Bug: "
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue. Please fill out the below template with as much detail as possible. Incomplete bug reports are likely to be closed without comment.

If you want to suggest a feature use the
[Feature Request template](https://github.com/akaihola/darglint2/issues/new?template=feature_request.md)
instead.

- type: checkboxes
id: checklist-existing-issues
attributes:
label: Existing Issues
description: |
Please do not create a new issue for a problem that was already reported but use the existing thread.
However issues that only exist in the original [darglint](https://github.com/terrencepreilly/darglint)
repository may be reported again in this one.
Please link all issues that might relate to this report below.
options:
- label: |
I have searched the [darglint2 issue tracker](https://github.com/akaihola/darglint2/issues?q=is%3Aissue)
for open and closed issues to avoid duplicates.
required: true
- label: |
I have searched the [darglint issue tracker](https://github.com/terrencepreilly/darglint/issues?q=is%3Aissue)
for open and closed issues.
required: false

- type: textarea
id: related-issues
attributes:
label: Related issues
description: Link all issues that might relate to this report.
placeholder: |
- #14
- terrencepreilly/darglint#78

- type: textarea
id: description
attributes:
label: Description
description: |
Please describe your issue and its context in a clear and concise way.
Please create a minimal, reproducible example (MRE) that you have actually tested to work.
Please also use a minimal configuration and make sure that you don't overlook any config files in your working directory.
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve
Please enclose the minimal example and the corresponding output.

Use code blocks with `py`, `pytb`, `dosini` or `toml` highlighting where applicable.
placeholder: |
I encountered a bug.

```py
# minimal example (MRE)
```

Steps to reproduce:
1. Save MRE to `somefile.py`
2. Run `darglint2 <options>` in bash
3. See error

```
some output
```

```pytb
Error message
```

validations:
required: true

- type: input
id: version
attributes:
label: Version
description: Run `darglint2 --version` to find out.
validations:
required: true

- type: input
id: os
attributes:
label: OS
description: Operating system where useful (e.g. in case of OSErrors)
placeholder: <os> <version>
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Bug Report
about: Report a bug or a similiar issue - the classic way
title: ""
labels: "needs: triage"
assignees: ""
---

<!--
Thank you for reporting an issue. Please fill out the below template with
as much detail as possible. Incomplete bug reports are likely to be closed
without comment.

If you want to suggest a feature, please use our
[Feature Request template](https://github.com/akaihola/darglint2/issues/new?template=feature_request.md)
instead.
-->

#### Existing Issues

<!--
Please do not create a new issue for a problem that was already reported but use the existing thread.
However issues that only exist in the original [darglint](https://github.com/terrencepreilly/darglint)
repository may be reported again in this one.
Please link all issues that might relate to this report below.
-->

- [ ] I have searched the [darglint2 issue tracker](https://github.com/akaihola/darglint2/issues?q=is%3Aissue) for open and closed issues to avoid duplicates.
- [ ] I have searched the [darglint issue tracker](https://github.com/terrencepreilly/darglint/issues?q=is%3Aissue) for open and closed issues. (optional)

I have found the following related issues:

<!-- E.g.:

- #14
- terrencepreilly/darglint#78

-->

#### Description

<!-- Description
Please describe your issue and its context in a clear and concise way.
Please create a minimal, reproducible example (MRE) that you have actually tested to work.
Please also use a minimal configuration and make sure that you don't overlook any config files in your working directory.
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve
Please enclose the minimal example and the corresponding output.

Use code blocks with `py`, `pytb`, `dosini` or `toml` highlighting where applicable.
-->

<!-- E.g.
Steps to reproduce the behavior:
1. Save MRE to `somefile`
2. Run `some command` in bash
3. See error
-->

#### Environment

<!--
Run `darglint2 --version`
Provide the OS where useful (e.g. in case of OSErrors)
-->

- Version:
- OS:
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
contact_links:
- name: Documentation
url: https://akaihola.github.io/darglint2/
about: Documentation on installing, using and contributing to Darglint2.

- name: Support
url: https://github.com/akaihola/darglint2/discussions/categories/faq
real-yfprojects marked this conversation as resolved.
Show resolved Hide resolved
about: Please ask for support in the Discussions FAQ.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature Request
about: Suggest an idea for this project.
title: "FR: "
labels: "type:enhancement"
assignees: ""
---

#### The problem

<!--
Is your feature request related to a problem?
Please provide a clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]
-->

#### Requested Solution

<!--
A clear and concise description of what you want to happen.
-->

#### Alternatives

<!--
A clear and concise description of any alternative solutions or features you've considered.
-->

#### Additional context

<!--
Add any other context or screenshots about the feature request here.
-->
62 changes: 62 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!--- Provide a general summary of your changes in the Title above -->

### Description

<!--- Describe your changes in detail -->

### Related Issue

<!---
It is usually good practice to open an issue first before creating a PR.
If suggesting a new feature or change, please discuss it in an issue first.
If fixing a bug, there should be an issue describing it with steps to reproduce.
However we won't turn your PR down just because such an issue is missing.
Please link to the issue here. E.g.:

Fixes #12

-->

### Motivation and Context

<!--- Why is this change required? What problem does it solve? -->

### How Has This Been Tested?

<!---
Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.
-->

### Screenshots (if appropriate):

### Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

### Checklist:

<!---
Go over all the following points, and put an `x` in all the boxes that apply.
If you're unsure about any of these, don't hesitate to ask. We're here to help!
-->

- [ ] I have read the [CONTRIBUTING]() guide.
- [ ] My code follows the [code style]() of this project.
Comment on lines +49 to +50
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder: need to add links

- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

_I provide my contribution under the terms of the [license](./../../LICENSE.txt) of this repository and I affirm the [Developer Certificate of Origin][dco]._

[dco]: https://developercertificate.org/

<!--
This template is sourced from the awesome https://github.com/TalAter/open-source-templates
-->
Loading