diff --git a/.github/ISSUE_TEMPLATE/agency-schema-addition.md b/.github/ISSUE_TEMPLATE/agency-schema-addition.md new file mode 100644 index 0000000..637376c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/agency-schema-addition.md @@ -0,0 +1,28 @@ +--- +name: Add agency extended schema +about: Add an agency's code.json extended schema to the repository +title: "[SCHEMA]" +labels: schema, agency-schema +assignees: natalialuzuriaga +--- + +## Request - Add Agency Schema + +This issue serves as a request to add an agency's extended code.json schema to the repository. For more information, please visit: https://github.com/DSACMS/gov-codejson/blob/main/docs/metadata.md#extending-the-schema-for-agency-use + +### Agency +What agency is this for? + +### New Fields in Extended Schema + +Fill out the information below on the fields of your agency's extended code.json schema. Please refer to the structure of the code.json fields found here: https://github.com/DSACMS/gov-codejson/blob/main/schemas/schema-1.0.0.json + +``` +"key-name-here": { + "type": "____", + "description": "One liner describing new field here" + }, +``` + +Provide example values here: + diff --git a/.github/ISSUE_TEMPLATE/metadata-field-addition.md b/.github/ISSUE_TEMPLATE/metadata-field-addition.md index 9acccb9..fbc62a0 100644 --- a/.github/ISSUE_TEMPLATE/metadata-field-addition.md +++ b/.github/ISSUE_TEMPLATE/metadata-field-addition.md @@ -1,18 +1,18 @@ --- name: Metadata Field Addition -about: Suggest a field to add to code.json schema +about: Suggest a field to add to CMS code.json schema title: "[METADATA]" labels: schema assignees: natalialuzuriaga --- -## Issue Report - Metadata +## Request - Metadata -module-name: One line summary of the issue (less than 72 characters) +This issue serves as a request to add new fields to the CMS code.json schema. For more information, please visit: https://github.com/DSACMS/gov-codejson/blob/main/docs/metadata.md#adding-new-metadata-fields ### Proposed Field information -Fill out the information below on the new proposed field. Please refer to the structure of the code.json fields found here: https://github.com/DSACMS/gov-codejson/blob/main/schemas/schema-0.1.0.json +Fill out the information below on the new proposed field. Please refer to the structure of the code.json fields found here: https://github.com/DSACMS/gov-codejson/blob/main/schemas/schema-1.0.0.json ``` "key-name-here": { diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03068db..17fc112 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its If you would like to comment and provide feedback on the metadata standard, please let us know by filing an **issue on our GitHub repository.** -We encourage agencies to contribute by submitting a pull request to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. +We encourage agencies to contribute by [submitting an agency schema addition issue](https://github.com/DSACMS/gov-codejson/issues) to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. For CMS, we are open to adding more fields to CMS code.json for any metadata the agency sees value in collecting. Request new metadata fields by filing a metadata field addition issue [here](https://github.com/DSACMS/gov-codejson/issues/new?template=metadata-field-addition.md). diff --git a/docs/faq.md b/docs/faq.md index 2498593..671a7ab 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -62,4 +62,4 @@ We are open to adding more fields to CMS code.json for any metadata the agency s ### My agency extended the code.json schema to add more metadata fields. Where can I share this? -We encourage agencies to contribute by submitting a pull request to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. \ No newline at end of file +We encourage agencies to contribute by [submitting an agency schema addition issue](https://github.com/DSACMS/gov-codejson/issues) to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. \ No newline at end of file diff --git a/docs/metadata.md b/docs/metadata.md index 0bc47a0..6b4656b 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -16,7 +16,7 @@ The generic schema is designed to be extensible, allowing agencies to add metada For example, CMS has their [own schema](../schemas/cms/) that includes new fields such as FISMA level, subset in healthcare, and systems. -We encourage agencies to contribute by submitting a pull request to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. +We encourage agencies to contribute by [submitting an agency schema addition issue](https://github.com/DSACMS/gov-codejson/issues) to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. ### Fields