Skip to content

Commit

Permalink
Feature/add issue types (#139)
Browse files Browse the repository at this point in the history
* Added issue for suggesting a feature

* Added an issue for updating documentation

* Added labels and assignees on all issue templates

* Added trailing space to title of bug report issue type
  • Loading branch information
jamie-taylor-rjj authored Dec 3, 2024
1 parent ca01a30 commit 53bf356
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 7 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/ask_a_question.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
name: Ask a Question
about: Please feel free to ask a question about OWaspHeaders.Core here.
title: ''
labels: ''
assignees: ''
title: 'Question: '
labels: ['question']
assignees:
- 'GaProgMan'
---

## My Question
Expand Down
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
name: Report a bug
about: Please report any bugs with the code or documentation here.
title: ''
labels: ''
assignees: ''
title: 'Bug report: '
labels: ['bug', 'branch required']
assignees:
- 'GaProgMan'
---

## The Issue
## The Bug

Please describe the issue in as much detail as you can here.

Expand Down
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/suggest_a_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Suggest a Feature
about: Please suggest any new features and/or HTTP headers here.
title: 'Feature Request: '
labels: ['enhancement', 'branch required']
assignees:
- 'GaProgMan'
---

## My Feature Request

Please provide as much detail about the feature or HTTP header that you are requesting here. If you are requesting an HTTP header, please link to both the [MDN](https://developer.mozilla.org/en-US/) and [OWASP Secure Headers Project](https://owasp.org/www-project-secure-headers/#div-headers) pages for that header.

## Minimal Code Sample

The following is a [minimal code sample](https://gaprogman.github.io/OwaspHeaders.Core/Minimal-Code-Sample/) which helps to highlight the potential design for the feature or HTTP header.

```cs
// in Program.cs
app.UseSecureHeadersMiddleware();
```
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/update_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Update Documentation
about: Please feel free to raise documentation change requests here.
title: 'Docs update: '
labels: ['docs', 'branch required']
assignees:
- 'GaProgMan'
---

## Documentation Update

Please be as specific as you can about the documentation which needs to be updated and link to either the [MDN](https://developer.mozilla.org/en-US/) or [OWASP Secure Headers Project](https://owasp.org/www-project-secure-headers/#div-headers) pages which supports the documentation change.

0 comments on commit 53bf356

Please sign in to comment.