From 430d0e2aa6390fea8dd59ecff63e661f45186640 Mon Sep 17 00:00:00 2001 From: Andrew Barna Date: Wed, 14 May 2025 20:50:01 -0700 Subject: [PATCH 1/5] add issue template for param requests --- .github/ISSUE_TEMPLATE/param_request.yml | 64 ++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/param_request.yml diff --git a/.github/ISSUE_TEMPLATE/param_request.yml b/.github/ISSUE_TEMPLATE/param_request.yml new file mode 100644 index 0000000..6b01f4a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/param_request.yml @@ -0,0 +1,64 @@ +name: New Parameter +description: Request that a new parameter be added +labels: ["new parameter"] +body: + - type: input + id: whp_name + attributes: + label: WHP Name + description: The name that would appear in an exchange data file, this is case sensitive. + placeholder: e.g. CTDSAL + validations: + required: true + - type: input + id: whp_units + attributes: + label: WHP Units + description: The units, if any, that would appear in an exchange data file, this is case senstive + placeholder: e.g. PSS-78 + validations: + required: false + - type: textarea + id: description + attributes: + label: Parameter Description + description: What is this parameter? If it has a methods paper, link to it here. If this parameter is optical in nature, what are the relivant: wavelengths (ex, em), pathlengths, scattering angles. + validations: + required: true + - type: textarea + id: data-files + attributes: + label: Data Files + description: Please provide links to the data which have this new parameter in it. + validations: + required: false + - type: markdown + attributes: + value: | + Extra information that will be useful + - type: input + id: cf_name + attributes: + label: CF Standard Name + description: Does this parameter have an equivalent CF standard name already? If yes what is it? + placeholder: e.g. moles_of_oxygen_per_unit_mass_in_sea_water + validations: + required: false + - type: input + id: si_units + attributes: + label: SI Units + description: If the WHP Units aren't actual SI units, what are the? For dimensionless parameters a "None" or 1 can be entered + placeholder: e.g. 1 + validations: + required: false + - type: input + id: p01_name + attributes: + label: VNS P01 Name + description: | + Does this parameter exist in [NVS P01](http://vocab.nerc.ac.uk/collection/P01/current/)? + Try to be as specific as possible, in many files, these codes will look like "SDN:P01::DOXYSCKG" + placeholder: e.g. DOXYSCKG + validations: + required: false \ No newline at end of file From 622dc298f77babc725ab5145c23764f8566d24db Mon Sep 17 00:00:00 2001 From: Andrew Barna Date: Wed, 14 May 2025 20:53:37 -0700 Subject: [PATCH 2/5] actually make the yaml valid --- .github/ISSUE_TEMPLATE/param_request.yml | 70 ++++++++++++------------ 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/param_request.yml b/.github/ISSUE_TEMPLATE/param_request.yml index 6b01f4a..2906865 100644 --- a/.github/ISSUE_TEMPLATE/param_request.yml +++ b/.github/ISSUE_TEMPLATE/param_request.yml @@ -2,27 +2,27 @@ name: New Parameter description: Request that a new parameter be added labels: ["new parameter"] body: - - type: input - id: whp_name - attributes: - label: WHP Name - description: The name that would appear in an exchange data file, this is case sensitive. - placeholder: e.g. CTDSAL - validations: - required: true - - type: input - id: whp_units - attributes: - label: WHP Units - description: The units, if any, that would appear in an exchange data file, this is case senstive - placeholder: e.g. PSS-78 - validations: - required: false + - type: input + id: whp_name + attributes: + label: WHP Name + description: The name that would appear in an exchange data file, this is case sensitive. + placeholder: e.g. CTDSAL + validations: + required: true + - type: input + id: whp_units + attributes: + label: WHP Units + description: The units, if any, that would appear in an exchange data file, this is case senstive + placeholder: e.g. PSS-78 + validations: + required: false - type: textarea id: description attributes: label: Parameter Description - description: What is this parameter? If it has a methods paper, link to it here. If this parameter is optical in nature, what are the relivant: wavelengths (ex, em), pathlengths, scattering angles. + description: "What is this parameter? If it has a methods paper, link to it here. If this parameter is optical in nature, what are the relivant: wavelengths (ex, em), pathlengths, scattering angles." validations: required: true - type: textarea @@ -36,29 +36,29 @@ body: attributes: value: | Extra information that will be useful - - type: input - id: cf_name - attributes: + - type: input + id: cf_name + attributes: label: CF Standard Name description: Does this parameter have an equivalent CF standard name already? If yes what is it? placeholder: e.g. moles_of_oxygen_per_unit_mass_in_sea_water - validations: + validations: required: false - - type: input - id: si_units - attributes: + - type: input + id: si_units + attributes: label: SI Units description: If the WHP Units aren't actual SI units, what are the? For dimensionless parameters a "None" or 1 can be entered placeholder: e.g. 1 - validations: + validations: required: false - - type: input - id: p01_name - attributes: - label: VNS P01 Name - description: | - Does this parameter exist in [NVS P01](http://vocab.nerc.ac.uk/collection/P01/current/)? - Try to be as specific as possible, in many files, these codes will look like "SDN:P01::DOXYSCKG" - placeholder: e.g. DOXYSCKG - validations: - required: false \ No newline at end of file + - type: input + id: p01_name + attributes: + label: VNS P01 Name + description: | + Does this parameter exist in [NVS P01](http://vocab.nerc.ac.uk/collection/P01/current/)? + Try to be as specific as possible, in many files, these codes will look like "SDN:P01::DOXYSCKG" + placeholder: e.g. DOXYSCKG + validations: + required: false \ No newline at end of file From 4b9d1821088e745da95b6919bb24c033ef2a2a95 Mon Sep 17 00:00:00 2001 From: Andrew Barna Date: Wed, 14 May 2025 20:54:58 -0700 Subject: [PATCH 3/5] use h2 for the extra information section --- .github/ISSUE_TEMPLATE/param_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/param_request.yml b/.github/ISSUE_TEMPLATE/param_request.yml index 2906865..47c7ad4 100644 --- a/.github/ISSUE_TEMPLATE/param_request.yml +++ b/.github/ISSUE_TEMPLATE/param_request.yml @@ -35,7 +35,7 @@ body: - type: markdown attributes: value: | - Extra information that will be useful + ## Extra information that will be useful - type: input id: cf_name attributes: From 631a0dbc120890c6b8b9118f3ef9208dc56b6967 Mon Sep 17 00:00:00 2001 From: Andrew Barna Date: Wed, 14 May 2025 20:56:10 -0700 Subject: [PATCH 4/5] fix typoe of si unit description --- .github/ISSUE_TEMPLATE/param_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/param_request.yml b/.github/ISSUE_TEMPLATE/param_request.yml index 47c7ad4..4c1d5c2 100644 --- a/.github/ISSUE_TEMPLATE/param_request.yml +++ b/.github/ISSUE_TEMPLATE/param_request.yml @@ -48,7 +48,7 @@ body: id: si_units attributes: label: SI Units - description: If the WHP Units aren't actual SI units, what are the? For dimensionless parameters a "None" or 1 can be entered + description: If the WHP Units aren't actual SI units, what are they? For dimensionless parameters like practical salinity a "None" or 1 can be entered. placeholder: e.g. 1 validations: required: false From 95381b97dbd7b87ea05f6fca016dec28774482e0 Mon Sep 17 00:00:00 2001 From: Andrew Barna Date: Fri, 16 May 2025 14:07:32 -0700 Subject: [PATCH 5/5] spell check param request issue template --- .github/ISSUE_TEMPLATE/param_request.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/param_request.yml b/.github/ISSUE_TEMPLATE/param_request.yml index 4c1d5c2..2770e57 100644 --- a/.github/ISSUE_TEMPLATE/param_request.yml +++ b/.github/ISSUE_TEMPLATE/param_request.yml @@ -14,7 +14,7 @@ body: id: whp_units attributes: label: WHP Units - description: The units, if any, that would appear in an exchange data file, this is case senstive + description: The units, if any, that would appear in an exchange data file, this is case sensitive placeholder: e.g. PSS-78 validations: required: false @@ -22,7 +22,7 @@ body: id: description attributes: label: Parameter Description - description: "What is this parameter? If it has a methods paper, link to it here. If this parameter is optical in nature, what are the relivant: wavelengths (ex, em), pathlengths, scattering angles." + description: "What is this parameter? If it has a methods paper, link to it here. If this parameter is optical in nature, what are the relevant: wavelengths (ex, em), path lengths, scattering angles." validations: required: true - type: textarea