Skip to content

Commit

Permalink
Improve issue and metadata templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiggi committed Nov 5, 2023
1 parent be640af commit f75e8f3
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
name: ➕ Feature request
description: Suggest an idea for this project
name: 📝 Add new metadata
description: Describe the stations new metadata
title: "[FEATURE] <title>"
labels: [enhancement, triage]
body:
- type: textarea
attributes:
label: What types of data would you like to add ?
description: A clear and concise description of the type of data.
label: Describe the stations metadata you would like to add !
validations:
required: false
- type: textarea
attributes:
label: Additional context.
description: Add any other context or information about the feature request here.
description: Add any other context or information about the data you would like to contribute.
validations:
required: false
required: false
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: ➕ Feature request
about: Suggest an idea for this project
title: ''
description: What is your feature request ?
title: "[FEATURE] <title>"
labels: [enhancement, triage]
assignees: ghiggi

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen. Please explain why and how it helps your users.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/report_metadata_error.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: ⚠️ Report metadata errors
description: Describe the stations metadata which contain errors
title: "[FEATURE] <title>"
labels: [enhancement, triage]
body:
- type: textarea
attributes:
label: Describe the stations metadata which contain erroneous information !
validations:
required: false
- type: textarea
attributes:
label: Additional context.
description: Add any other context or information about the concerned stations.
validations:
required: false
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/update_metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: 📝 Update existing metadata
description: Describe the stations metadata which require an update !
title: "[FEATURE] <title>"
labels: [enhancement, triage]
body:
- type: textarea
attributes:
label: Describe the stations metadata you would like to update !
validations:
required: false
- type: textarea
attributes:
label: Additional context.
description: Add any other context or information about the concerned stations.
validations:
required: false
23 changes: 20 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# Prework

By submitting this pull request, I understand and agree to this repository's [code of conduct](https://github.com/EPFL-ENAC/LTE-disdrodb-data/blob/main/CODE_OF_CONDUCT.md) and [contributing guidelines](https://github.com/EPFL-ENAC/LTE-disdrodb-data#how-to-add-my-own-data-to-disdrodb-).
- [ ] I understand and agree to this repository's [code of conduct](https://github.com/ltelab/disdrodb-data/blob/main/CODE_OF_CONDUCT.md).
- [ ] I understand and agree to this repository's [contributing guidelines](https://github.com/ltelab/disdrodb/blob/main/CONTRIBUTING.rst).

**What does this PR do?** (check at least one)

- [ ] Add new station(s)/campaign(s) metadata
- [ ] Update metadata YAML information
- [ ] Update issue YAML information
- [ ] Repository-related changes
- [ ] Other, please describe:

# Summary
**The PR fulfills these requirements:**

- [ ] It's submitted to the branch named as follow :
- Add station metadata: `add-metadata-<data_source>-<campaign_name>-<station_name>`
- Add campaign stations metadata: `add-metadata-<data_source>-<campaign_name>`
- Update station metadata: `update-metadata-<data_source>-<campaign_name>-<station_name>`
- Update stations metadata: `update-metadata-<data_source>-<campaign_name>`
- Add a new feature: `feature-<some_key>-<word>`
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
- [ ] Don't forget to link PR to issue if you are solving one.

Please describe briefly the data you are uploading.
# Summary

Please describe briefly the station metadata you are adding or updating.

# Comments

Expand Down

0 comments on commit f75e8f3

Please sign in to comment.