From 360391435f8840ecd7aa9f4459ebc6bd36226656 Mon Sep 17 00:00:00 2001 From: Justin Edmund Date: Wed, 15 Jan 2025 18:06:00 -0800 Subject: [PATCH] Update PR templates --- .github/PULL_REQUEST_TEMPLATE.md | 9 +++ .github/PULL_REQUEST_TEMPLATE/data_update.md | 68 ++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/default.md | 26 ++++++++ .github/pull_request_template.md | 41 ------------ 4 files changed, 103 insertions(+), 41 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/data_update.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/default.md delete mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..398af0f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +blank_issues_enabled: false +contact_links: + +- name: Default Pull Request + url: .github/PULL_REQUEST_TEMPLATE/default.md + about: For general changes and updates +- name: Data Update Pull Request + url: .github/PULL_REQUEST_TEMPLATE/data_update.md + about: For game data updates and modifications diff --git a/.github/PULL_REQUEST_TEMPLATE/data_update.md b/.github/PULL_REQUEST_TEMPLATE/data_update.md new file mode 100644 index 0000000..aae8f06 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/data_update.md @@ -0,0 +1,68 @@ +name: Data Update +description: For game data updates and modifications +body: + +- type: markdown + attributes: + value: | + ## Data Update +- type: textarea + id: summary + attributes: + label: Summary + description: Describe what this data update includes + placeholder: "Adding new Valentines 2024 characters" + validations: + required: true +- type: textarea + id: new-additions + attributes: + label: New Additions + description: List new items being added, grouped by type + value: | + ##### Characters + - + ##### Weapons + - + ##### Summons + - +- type: textarea + id: modifications + attributes: + label: Modifications + description: List existing items being modified + value: | + ##### Characters + - + ##### Weapons + - + ##### Summons + - +- type: textarea + id: csv-files + attributes: + label: CSV Files Added + description: List all CSV files included in this update + value: | + - [ ] `YYYYMMDD-characters-XXX.csv` + - [ ] `YYYYMMDD-weapons-XXX.csv` + - [ ] `YYYYMMDD-summons-XXX.csv` +- type: checkboxes + id: data-checklist + attributes: + label: Checklist + options: + - label: CSV files use the correct naming format (`YYYYMMDD-{type}-XXX.csv`) + - label: CSV files are in the correct location (`db/seed/updates/`) + - label: All required fields are filled out + - label: Dates use the correct format (`YYYY-MM-DD`) + - label: Boolean values are either `true` or `false` + - label: Arrays use the correct format (e.g., `{value1,value2}`) + - label: Ran import in test mode (`bin/rails granblue:import_data TEST=true`) +- type: textarea + id: test-results + attributes: + label: Test Results + description: Paste the output from running the import in test mode + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/default.md b/.github/PULL_REQUEST_TEMPLATE/default.md new file mode 100644 index 0000000..a2616ba --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/default.md @@ -0,0 +1,26 @@ +name: Default Pull Request +description: For general changes and updates +body: + +- type: markdown + attributes: + value: | + ## Description + Please provide a clear description of your changes. +- type: textarea + id: changes + attributes: + label: Changes Made + description: List the main changes in this PR + placeholder: "- Added feature X\n- Fixed bug Y\n- Updated documentation for Z" + validations: + required: true +- type: checkboxes + id: checks + attributes: + label: Checklist + options: + - label: I have tested my changes + - label: I have updated relevant documentation + - label: My changes generate no new warnings + - label: I have added tests if applicable diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index f883205..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,41 +0,0 @@ -## Data Update - -### Summary - - -#### New Additions - -- Characters: - - [ ] -- Weapons: - - [ ] -- Summons: - - [ ] - -#### Modifications - -- Characters: - - [ ] -- Weapons: - - [ ] -- Summons: - - [ ] - -### CSV Files Added - -- [ ] `YYYYMMDD-characters-XXX.csv` -- [ ] `YYYYMMDD-weapons-XXX.csv` -- [ ] `YYYYMMDD-summons-XXX.csv` - -### Checklist - -- [ ] CSV files use the correct naming format (`YYYYMMDD-{type}-XXX.csv`) -- [ ] CSV files are in the correct location (`db/seed/updates/`) -- [ ] All required fields are filled out -- [ ] Dates use the correct format (`YYYY-MM-DD`) -- [ ] Boolean values are either `true` or `false` -- [ ] Arrays use the correct format (e.g., `{value1,value2}`) -- [ ] Ran import in test mode (`bin/rails granblue:import_data TEST=true`) - -### Test Results -