Skip to content

Commit

Permalink
Add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
dalito committed Aug 18, 2023
1 parent 2ee9438 commit 44a34c7
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 2 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 🐞 Bug
description: File a bug report
title: "🐞 <title>"
labels: ["Bug"]
body:
- type: input
id: version
attributes:
label: Observed in version
validations:
required: false

- type: textarea
id: description
attributes:
label: Description
render: markdown
validations:
required: false
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: 💡 Improvement
description: Suggest an improvement
title: "💡 <title>"
labels: ["Enhancement"]
body:
- type: textarea
id: description
attributes:
label: Description
render: markdown
validations:
required: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/request-ids.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: 🙋 Request a range of IDs
description: To add new content you need IDs. Here you get them!
title: "🙋 ID-request"
labels: []
assignees: []
body:
- type: markdown
id: intro
attributes:
value: >
We track provenance and want to give credit to contributors.
Therefore, we ask for your [ORCID](https://orcid.org) below.
If you don't have one, we can use your GitHub name instead.
In addition you can supply the [ROR](https://ror.org) of the organization you work for.
Also tell us how many IDs you need.
- type: input
id: orcid
attributes:
label: Your ORCID identifier.
- type: input
id: ror
attributes:
label: The ROR of the organization you work for.
- type: input
id: count
attributes:
label: Number of IDs requested.
- type: textarea
id: message
attributes:
label: Additional information on your plans.
render: markdown
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All vocabularies based on this template have the same standard contribution proc
- submit a pull request with the updated file,
- collaborate on the pull request with editors or other github users,

After approval your pull request is ready to be merged by the editors. The merge will include your contribution into the SKOS-vocabulary file in the `vocabularies`-folder and it will also be reflected in the documentation that is automatically updated.
After approval your pull request is ready to be merged by the editors. The merge will include your contribution into the SKOS-vocabulary file in the `vocabularies`-folder. Upon merge the corresponding documentation and a joined turtle file will be automatically built and published to gh-pages.

The Excel/xlsx files submitted as pull request are automatically checked and (if all is good) converted to turtle.
By using a vocabulary-specific configuration more thorough validation can be activated,
Expand All @@ -25,6 +25,7 @@ To validate IRIs the configuration supports ID-ranges (similar to [OBO idrange](
The idea is that every author gets their own range of IDs to consume.
This allows independent work and avoids using the same ID repeatedly.


The voc4cat-template implements automatic storage of different versions of the vocabularies in gh-pages:

- `dev` - Directory with artifacts built from the most recent commit to the main branch.
Expand Down Expand Up @@ -68,7 +69,7 @@ Here are the steps for submitting updates in Excel.
- or why the proposed change may not fit.
- If you need to fix something update the pull request branch. This will trigger the pipeline to run again.

Finally, when the proposed merge request is accepted, your changes will be integrated in the vocabularies in the folder `vocabularies`. The vocabularies are stored in split form using one folder per vocabulary. Each concept, collection and concept scheme is stored in a separate file using the ID-part of the IRI as file name.
Finally, when the proposed merge request is accepted, your changes will be integrated in the vocabularies in the folder `vocabularies`. The vocabularies are stored in split form using one folder per vocabulary. Each concept, collection and concept scheme is stored in a separate file using the ID-part of the IRI as file name.

See [inbox-excel-vocabs/README.md](inbox-excel-vocabs/README.md) for a minimal example how to test the submission process.

Expand Down

0 comments on commit 44a34c7

Please sign in to comment.