Skip to content

Commit

Permalink
Add contributor templates for issues and pull requests (#74)
Browse files Browse the repository at this point in the history
* Set up dotnet in dependent workflows

* Adding contributor templates and configuration

* Update pull_request_template.md

* Update pull_request_template.md
  • Loading branch information
DennisDyallo authored Apr 16, 2024
1 parent 043119a commit 13aea4b
Show file tree
Hide file tree
Showing 7 changed files with 187 additions and 1 deletion.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/1-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: ❔Question
description: Ask a question or seek clarification about the project.
title: "[Question]: <title>"
labels: ["question"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to ask a question! We strive to respond as quickly as possible.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: question
attributes:
label: What is your question?
description: Please be as detailed as possible.
placeholder: What do you want to know?
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Any additional context around the question.
placeholder: Provide more background information here.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: 🐞 Bug
description: File a bug/issue.
title: "[BUG] <title>"
labels: ["bug"]
projects: []
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: false
- type: input
id: version-sdk
attributes:
label: Version
description: What version of our SDK are you using?
placeholder: 1.10.0
validations:
required: true
- type: input
id: version-firmare
attributes:
label: Version
description: What version of our firmware are you running?
placeholder: 5.4.3
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/3-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 💡 Feature Request
description: Suggest an idea for this project.
title: "[Feature]: <title>"
labels: ["enhancement"]
projects: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: Describe the feature you would like to see.
placeholder: Describe your feature here.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: What is the motivation or use case for this feature?
placeholder: Tell us why the feature is important.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [contribution guidelines](https://raw.githubusercontent.com/Yubico/Yubico.NET.SDK/043119ad1d19e0e6e66556c970a81d0c1aba36c8/CONTRIBUTING.md).
options:
- label: I agree to follow this project's contribution guidelines
required: true
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 @@
blank_issues_enabled: false
contact_links:
- name: Official SDK Documentation and User Manual
url: https://docs.yubico.com/yesdk/
about: Find your answer in our documentation.
- name: The Yubico Blog
url: https://www.yubico.com/blog/
about: Stay up to date on company and partner news, product tips, and industry trends.
33 changes: 33 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # <link to issue(s)>

## Type of change

Please delete options that are not relevant.

- [ ] 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 not work as expected)
- [ ] This change requires a documentation update

# How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

**Test configuration**:
* Firmware version:
* Yubikey model:

# Checklist:

- [ ] My code follows the [style guidelines](https://raw.githubusercontent.com/Yubico/Yubico.NET.SDK/043119ad1d19e0e6e66556c970a81d0c1aba36c8/CONTRIBUTING.md) of this project
- [ ] I have performed a self-review of my own code
- [ ] I have run `dotnet format` to format my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
5 changes: 4 additions & 1 deletion .github/workflows/check-code-formatting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@ jobs:
runs-on: windows-2019

steps:
# Checkout the local repository
- uses: actions/checkout@v4

- uses: actions/setup-dotnet@v4
with:
global-json-file: global.json

- name: Add local NuGet repository
run: dotnet nuget add source --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/Yubico/index.json"

Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/test-and-cover.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ jobs:

steps:
- uses: actions/checkout@v4

- uses: actions/setup-dotnet@v4
with:
global-json-file: global.json

- name: Add local NuGet repository
run: dotnet nuget add source --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/Yubico/index.json"
Expand Down

0 comments on commit 13aea4b

Please sign in to comment.