diff --git a/.github/ISSUE_TEMPLATE/propose-tool.md b/.github/ISSUE_TEMPLATE/propose-tool.md index b7ee2f06b..034c7875e 100644 --- a/.github/ISSUE_TEMPLATE/propose-tool.md +++ b/.github/ISSUE_TEMPLATE/propose-tool.md @@ -2,30 +2,74 @@ name: "\U+1F4CB Propose new tool" about: Suggest a new tool to be included in the Toolkit title: '' -labels: "Needs: Triage \U0001F50D, Type: Feature \U0001F48E" +labels: "Needs: Triage \U0001F50D, Type: New Tool \U26A1" assignees: '' --- -## New Tool Submission +## Thank you for contributing! +Thank you for taking the time to propose a new tool for the FinOps toolkit. 🙌 -### Tool Name: -[Insert Tool Name] +As part of this process, once the tool is merged, you’ll take on the important role of its technical lead. To better understand what this entails, please review the [technical lead responsibilities here](https://github.com/microsoft/finops-toolkit/blob/dev/docs-wiki/Advisory-council.md). -### Description: -[Provide a brief description of the tool and its intended purpose.] +- [ ] I acknowledge the responsibilities of a technical lead and agree to serve as the technical lead for this tool once it is merged. -### Use Case: -[Explain the use case or scenarios where this tool would be beneficial for FinOps practitioners.] -### Functionality: -[Outline the key features and functionalities of the tool.] +## 1. Tool overview (Mandatory) +**Tool Name:** +_Provide a clear, descriptive name for the tool._ -### Implementation: -[Provide guidance or instructions on how to implement and utilize the tool.] +Description: +_Summarize the purpose and functionality of the tool._ -### Additional Information: -[Include any additional information, links, or resources related to the tool.] +Use case: +_What problem does this tool solve? Who will benefit from it?_ -### Contributor Information: +**Services used:** +_What are the Azure services needed to deploy this tool?_ + +**Dependencies:** +_List any dependencies, such as other tools, data sources, or teams._ + +### Contributor information: - **Name**: [Your Name] -- **Contact Email**: [Your Email Address] + +--- + +## 2. Development plan (to be completed by onboarding lead) + + +**Onboarding lead:** + +_Name the tech lead overseeing this tool's onboarding._ + +**Initial tasks:** +_Outline the first steps or tasks for development._ + + +--- + +## 4. Supporting information (To be completed by tech lead) +**Mockups or diagrams:** +_Include visual representations, if available._ +```[tasklist] +- [ ] Diagram included +``` +--- + + +## 5. Progress tracking (To be completed by tech lead) +**Status updates:** +_This section will be updated by the tech lead throughout the development process._ + +| Task | Status | Comments | +|--------------------------------------|----------|-------------------| +| Discovery meeting completed | [ ] | | +| Feature branch created | [ ] | | +| Tasks outlined and assigned | [ ] | | +| Pull requests submitted | [ ] | | +| Tool reviewed and approved by tech lead | [ ] | | +| Governing board review completed | [ ] | | +| Merged into dev | [ ] | | + +--- + diff --git a/.github/ISSUE_TEMPLATE/propose-tool.yaml b/.github/ISSUE_TEMPLATE/propose-tool.yaml new file mode 100644 index 000000000..344e226dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/propose-tool.yaml @@ -0,0 +1,93 @@ +name: "📋 Propose New Tool" +description: "Suggest a new tool to be included in the Toolkit." +labels: + - "Needs: Triage 🔍" + - "Type: New Tool ⚡" +body: + - type: markdown + attributes: + value: | + ## Thank You for Contributing! + Thank you for taking the time to propose a new tool for the FinOps Toolkit. 🙌 + Please complete the following form to provide details about the tool you are suggesting. + - type: dropdown + id: submitter_type + attributes: + label: "Are you submitting your tool or someone else's?" + description: > + Select whether you are the owner of the tool or suggesting a tool developed by someone else. + Note: If you are not the owner, most fields in this form may not apply to you. + multiple: false + options: + - "I'm submitting a tool that I own." + - "I'm submitting a suggestion for someone else's tool (please specify below)." + default: 0 + validations: + required: true + + - type: checkboxes + attributes: + label: "Tool ownership responsibilities (only applicable to tool owners)" + description: > + To ensure the supportability and maintenance of the tool, we require the person proposing the tool to acknowledge the following responsibilities. + Please review the [responsibilities](https://github.com/microsoft/finops-toolkit/blob/dev/docs-wiki/Advisory-council.md) and check the box to proceed. + options: + - label: "I acknowledge the responsibilities of a technical lead and agree to serve in this role for the proposed tool upon its approval." + + - type: input + id: tool_name + attributes: + label: "Tool name" + description: "Provide a clear, descriptive name for the tool." + placeholder: "Enter the tool's name" + validations: + required: true + + - type: textarea + id: description + attributes: + label: "Description" + description: "Summarize the purpose and functionality of the tool." + placeholder: "Enter a short description" + validations: + required: true + + - type: textarea + id: use_case + attributes: + label: "Use case" + description: "What problem does this tool solve? Who will benefit from it?" + placeholder: "Describe the use case" + validations: + required: true + + - type: input + id: services_used + attributes: + label: "Services used" + description: "What Azure services are needed to deploy this tool?" + placeholder: "List required Azure services" + + - type: textarea + id: dependencies + attributes: + label: "Dependencies" + description: "List any dependencies, such as other tools, data sources, or teams." + placeholder: "Describe dependencies" + + - type: markdown + attributes: + value: | + ## Progress tracking (To Be Completed by the onboarding lead) + **Status Updates:** + The tech lead will update this section throughout the development process. + + | Task | Status | Comments | + |--------------------------------------|----------|-------------------| + | Discovery meeting completed | [ ] | | + | Feature branch created | [ ] | | + | Tasks outlined and assigned | [ ] | | + | Pull requests submitted | [ ] | | + | Tool reviewed and approved by tech lead | [ ] | | + | Governing board review completed | [ ] | | + | Merged into dev | [ ] | |