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

Convert issue templates from Markdown to YAML #39

Merged
merged 14 commits into from
Jul 11, 2024
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

This file was deleted.

58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Bug Report
description: Report a bug to help us improve
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Bug Description
description: Please provide a description of the problem
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Please describe what you expected would happen
validations:
required: true
- type: dropdown
id: version
attributes:
label: Affected Version
description: |
If applicable, provide the version number or release tag where this
issue was encountered
options:
- v1.0.0
default: 0
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Please provide all steps to reproduce the behavior
placeholder: |
1. In this environment...
1. With this config...
1. Run `this command`...
1. See error...
validations:
required: true
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: By submitting this issue, you agree to the following
options:
- label: I have read the [contributing guidelines](/CONTRIBUTING.md)
required: true
- label: I have verified this does not duplicate an existing issue
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: Feature Request
description: Suggest a feature for this project
title: "[Feature]: "
labels: ["feature", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request a feature or enhancement!
- type: textarea
id: description
attributes:
label: Problem Statement
description: |
Please describe the problem or limitation to be addressed by
the proposed feature
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Please describe what you envision the solution to this
problem would look like
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: |
Please briefly describe which alternatives, if any, have been
considered, including merits of alternate approaches and any tradeoffs
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: Please provide any other information that may be relevant
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: By submitting this request, you agree to the following
options:
- label: I have read the [contributing guidelines](/CONTRIBUTING.md)
required: true
- label: |
I have verified this does not duplicate an existing feature request
required: true
4 changes: 3 additions & 1 deletion .github/linters/.markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,6 @@ MD025:

# MD041/first-line-heading/first-line-h1
# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md
MD041: false
MD041:
# RegExp for matching title in front matter
front_matter_title: ""
3 changes: 2 additions & 1 deletion .github/linters/.yamllint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ extends: default

rules:
line-length:
max: 80
max: 120
level: warning
comments: disable
indentation: disable
truthy:
check-keys: false
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Description
# Description

Please provide a meaningful description of what this change will do, or is for.
Bonus points for including links to related issues, other PRs, or technical
Expand All @@ -19,7 +19,6 @@ much longer to review, or result in it not being reviewed at all.

## Checklist

<!-- TODO: Update the link below if docs stored in a different location -->
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
- [ ] Existing issues have been referenced (where applicable)
- [ ] I have verified this change is not present in other open pull requests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dependency.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ jobs:
uses: actions/dependency-review-action@0c155c5e8556a497adf53f2c18edabf945ed8e70 # v4.3.2
with:
fail-on-severity: "high"
deny-licenses: AGPL-1.0, AGPL-3.0
deny-licenses: "AGPL-1.0, AGPL-3.0"
comment-summary-in-pr: true
warn-on-openssf-scorecard-level: 3
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,25 @@ need to be made:
to (eg. `cisco-open`):
- [ ] In [`README.md`](README.md)
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] Change references to `repo_name` to the name of your new repo:
- [ ] Change references to `repo_name` to the name of your new repository:
- [ ] In [`README.md`](README.md)
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] Update the Release and Lint README badges to point to your project URL.
- [ ] Update the link to the contribution guidelines to point to your project:
- [ ] Update the Release and Lint `README` badges to point to your project URL.
- [ ] Update the link to the contribution guidelines if necessary:
- [ ] In
[`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md)
[`.github/ISSUE_TEMPLATE/bug_report.yml`](.github/ISSUE_TEMPLATE/bug_report.yml)
- [ ] In
[`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md)
[`.github/ISSUE_TEMPLATE/feature_request.yml`](.github/ISSUE_TEMPLATE/feature_request.yml)
- [ ] In
[`.github/pull_request_template.md`](.github/pull_request_template.md)
- [ ] Replace the `<project name>` placeholder with the name of your project:
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] In [`SECURITY.md`](SECURITY.md)
- [ ] Add names and contact information for actual project maintainers to
[`MAINTAINERS.md`](MAINTAINERS.md).
- [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourage you to
[keep a changelog](https://keepachangelog.com/en/1.0.0/).
- [ ] Configure [`.github/dependabot.yaml`](dependabot.yaml) for your project's
- [ ] Configure [`.github/dependabot.yml`](dependabot.yml) for your project's
language and tooling dependencies.
- [ ] Replace the generic content in this file with the relevant details about
your project.
Expand Down