From cf59c000d9022180d656aec607beaaf3a8931271 Mon Sep 17 00:00:00 2001 From: Justin Starry Date: Fri, 1 Apr 2022 21:16:56 +0800 Subject: [PATCH] Add issue template for feature gate tracking issues (#24040) * Add issue template for feature gate tracking issues * review feedback --- .github/ISSUE_TEMPLATE.md | 6 -- .github/ISSUE_TEMPLATE/0-general.md | 12 ++++ .github/ISSUE_TEMPLATE/1-feature-gate.yml | 70 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 +--- 4 files changed, 84 insertions(+), 15 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/0-general.md create mode 100644 .github/ISSUE_TEMPLATE/1-feature-gate.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index aa6686a189..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,6 +0,0 @@ -#### Problem - - - -#### Proposed Solution - diff --git a/.github/ISSUE_TEMPLATE/0-general.md b/.github/ISSUE_TEMPLATE/0-general.md new file mode 100644 index 0000000000..d4b6d77179 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0-general.md @@ -0,0 +1,12 @@ +--- +name: General Issue +about: Create a report describing a problem and a proposed solution +title: '' +assignees: '' +--- + +#### Problem + + + +#### Proposed Solution diff --git a/.github/ISSUE_TEMPLATE/1-feature-gate.yml b/.github/ISSUE_TEMPLATE/1-feature-gate.yml new file mode 100644 index 0000000000..dbf169c473 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-gate.yml @@ -0,0 +1,70 @@ +name: Feature Gate Tracker +description: Track the development and status of an on-chain feature +title: "Feature Gate: " +labels: ["feature-gate"] +body: + - type: markdown + attributes: + value: > + Steps to add a new feature are outlined below. Note that these steps only cover + the process of getting a feature into the core Solana code. + + - For features that are unambiguously good (ie bug fixes), these steps are sufficient. + + - For features that should go up for community vote (ie fee structure changes), more + information on the additional steps to follow can be found at: + + + 1. Generate a new keypair with `solana-keygen new --outfile feature.json --no-passphrase` + - Keypairs should be held by core contributors only. If you're a non-core contirbutor going + through these steps, the PR process will facilitate a keypair holder being picked. That + person will generate the keypair, provide pubkey for PR, and ultimately enable the feature. + + 2. Add a public module for the feature, specifying keypair pubkey as the id with + `solana_sdk::declare_id!()` within the module. Additionally, add an entry to `FEATURE_NAMES` map. + + 3. Add desired logic to check for and switch on feature availability. + - type: textarea + id: description + attributes: + label: Description + placeholder: Describe why the new feature gate is needed and any necessary conditions for its activation + validations: + required: true + - type: input + id: id + attributes: + label: Feature ID + description: The public key of the feature account + validations: + required: true + - type: dropdown + id: activation-method + attributes: + label: Activation Method + options: + - Single Core Contributor + - Staked Validator Vote + validations: + required: true + - type: input + id: testnet + attributes: + label: Testnet Activation Epoch + placeholder: Edit this response when feature is activated on this cluster + validations: + required: false + - type: input + id: devnet + attributes: + label: Devnet Activation Epoch + placeholder: Edit this response when feature is activated on this cluster + validations: + required: false + - type: input + id: mainnet-beta + attributes: + label: Mainnet-Beta Activation Epoch + placeholder: Edit this response when feature is activated on this cluster + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 23ae891af2..59f9a3b6c5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,9 @@ #### Problem - - - -#### Feature Gate Details - - - - #### Summary of Changes - Fixes # + +