Skip to content

Commit

Permalink
Update issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
coolharsh55 committed Jul 10, 2024
1 parent e20acac commit 8cf6364
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/fix-typo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Fix Typo or Error
description: Fix typo(s) or error(s) in RDF and HTML documents
title: "[FIX]: "
labels: ["todo"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this report!
- type: checkboxes
id: specs
attributes:
label: Specs
description: Please indicate which specification is affected by this
options:
- label: DPV
- label: Personal Data (PD)
- label: Technical (TECH)
- label: Locations (LOC)
- label: RISK
- label: AI
- label: Justifications
- label: LEGAL (e.g. IE, US)
- label: EU-GDPR
- label: EU-DGA
- label: EU-NIS2
- label: EU-AIAct
- label: EU-Rights
validations:
required: true
- type: textarea
id: errors
attributes:
label: Errors
description: Please list all typo(s), error(s), etc. here
placeholder: Errors can be typo(s), missing or broken links, missing images, wrong references, incorrect attributions...
value: Fix ...
validations:
required: true
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/how-to-use.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: How to use DPV for...?
description: Ask question(s) for how to use DPV for a specific application
title: "[HOW]: "
labels: ["todo"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to participate!
- type: checkboxes
id: specs
attributes:
label: Specs
description: Please indicate which specification the question is about
options:
- label: DPV
- label: Personal Data (PD)
- label: Technical (TECH)
- label: Locations (LOC)
- label: RISK
- label: AI
- label: Justifications
- label: LEGAL (e.g. IE, US)
- label: EU-GDPR
- label: EU-DGA
- label: EU-NIS2
- label: EU-AIAct
- label: EU-Rights
validations:
required: true
- type: textarea
id: question
attributes:
label: Question
description: What is the question or suggestion?
value: ...
validations:
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/suggest-concept.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Suggest New or Change Existing Concept(s)
description: Suggest new concept(s) or change existing concept(s)
title: "[Concept]: "
labels: ["todo"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out to participate!
- type: checkboxes
id: specs
attributes:
label: Specs
description: Please indicate which specification is affected by this
options:
- label: DPV
- label: Personal Data (PD)
- label: Technical (TECH)
- label: Locations (LOC)
- label: RISK
- label: AI
- label: Justifications
- label: LEGAL (e.g. IE, US)
- label: EU-GDPR
- label: EU-DGA
- label: EU-NIS2
- label: EU-AIAct
- label: EU-Rights
validations:
required: true
- type: textarea
id: new
attributes:
label: New Concept(s)
description: Please list all proposed new concept(s) here using the following structure
value: |
Term: e.g. NewConcept
Label: e.g. New Concept
Definition: e.g. this concept represents new concept
Parent term: e.g. Parent Cocept
Source: e.g. https://example.com or ISO-XYZ
Usage note: e.g. this concept should be used with specific consideration
validations:
required: false
- type: textarea
id: change
attributes:
label: Changed Concept(s)
description: Please list all proposed changes to existing concept(s) here using the following structure
value: |
Existing Term: e.g. dpv:NewConcept or risk:NewConcept
Change: e.g. change label from X to Y, or add usage note stating "xyz"
Justification: optional comment for why the change should be made
validations:
required: false
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pull Request

> **Important Note**: If your PR only includes commits to the RDF and HTML files directly - it will not be accepted. DPV's documentation generation happens via a workflow consisting of managing spreadsheets used for discussions, which are then used to generate the RDF and HTML. A PR adding/fixing something only in the 'output' will not be in snyc with the 'input'. Instead, please [open a new issue](https://github.com/w3c/dpv/issues/new) with the suggested changes. Attribution will be provided in commits for such changes e.g. Authored-by or Co-authored-by "Person". In case of questions, please [reach out to the maintainer](me@harshp.com) on how to best proceed.

0 comments on commit 8cf6364

Please sign in to comment.