Merge pull request Azure#819 from sdolgin/issue-templates

 Add Issue Templates for Feature Requests, Bug Reports, and Documentation Improvements

.github/ISSUE_TEMPLATE/01--content-request.yml

@@ -0,0 +1,37 @@
+name: 📝 Content Suggestions - Improve Azure Review Checklists
+description: Suggest changes to the recommendations or topics in the Azure Review Checklists. Your feedback helps us keep the checklists accurate and relevant!
+labels: ['json', 'enhancement']
+body:
+  - type: dropdown
+    id: content-type
+    attributes:
+      label: Type of Content Suggestion
+      description: Please select the type of content change you are suggesting.
+      options:
+        - Add a recommendation
+        - Retire a recommendation
+        - Modify an existing recommendation
+        - Add a new topic for recommendations (aka a new checklist)
+    validations:
+      required: true
+  - type: textarea
+    id: suggestion-details
+    attributes:
+      label: Description of Suggestion
+      description: Provide a detailed description of your suggestion. What changes are you proposing and why?
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Context and Rationale
+      description: Explain the context or reasons behind your suggestion. How will it improve the review checklists or help users?
+    validations:
+      required: false
+  - type: textarea
+    id: references
+    attributes:
+      label: References or Examples
+      description: Good recommendations should be based on recognized standards, best practices, or other authoritative sources. Include any references, examples, or additional information that supports your suggestion. It should be clear what the proposed source of the recommendation content will be.  
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/02--feature-request.yml

@@ -0,0 +1,46 @@
+name: 🚀 Feature Request - Suggest a new feature for Azure Review Checklists
+description: Propose a feature to enhance the Azure Review Checklists! Your ideas help to improve and evolve this resource for everyone 🎉
+labels: ['enhancement']
+body:
+  - type: textarea
+    attributes:
+      label: 🌟 Context and Purpose
+      description: How does this feature relate to the Azure Review Checklists? 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 🛠️ Problem Statement
+      description: What problem or need does this feature address? Ex. "The ALZ checklist should be translated to Valyrian ..."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 💡 Proposed Solution
+      description: Describe the feature or enhancement you're suggesting. Any specifics like checklist items, review process improvements, or Excel integration tweaks?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 🎯 Use Cases and Benefits
+      description: How will this feature be useful? What benefits does it bring to design reviews or users?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 🔍 Implementation Considerations
+      description: Any technical details or implementation tips? Consider JSON formatting, VBA tweaks, or Azure integration.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 🔄 Alternative Solutions
+      description: Thought about other approaches? Why might they not be as effective?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 📚 Additional Information
+      description: Any other context, such as links, examples, or feedback? We'd love to hear it!
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/03--bug-report.yml

@@ -0,0 +1,34 @@
+name: 🐞 Bug Report - Report an Issue with Azure Review Checklists
+description: Help us improve by reporting issues or bugs you've encountered. 
+labels: ['bug']
+body:
+  - type: textarea
+    attributes:
+      label: ⚠️ Problem Description
+      description: Clearly describe the issue you're experiencing. What is happening versus what you expected? Ex. "The ALZ checklist does not load in Excel..." 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 🛠️ Steps to Reproduce
+      description: List the steps to reproduce the issue. This helps us understand the context and identify the problem. Ex. "1. Open the checklist in Excel 2. Click on 'Import latest checklist'..."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 📸 Screenshots or Logs
+      description: If possible, provide screenshots or error messages. This visual information is extremely helpful!
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 💡 Environment Details
+      description: Provide details about your environment, such as OS, Excel version, and any specific configurations.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 🚀 Additional Context
+      description: Any other information you think might be helpful. Links to relevant documentation or previous issues are welcome.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/04--documentation-issue.yml

@@ -0,0 +1,34 @@
+name: 📖 Documentation Improvement - Enhance Azure Review Checklists Docs
+description: Help us improve our documentation by suggesting changes, corrections, or additions. Your insights are valuable! 🌟
+labels: ['documentation']
+body:
+  - type: textarea
+    attributes:
+      label: ✨ Improvement Suggestion
+      description: What specific improvement are you suggesting? Is it a correction, addition, or clarification? Ex. "Clarify the steps for using the workbooks..."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 🔍 Current State and Issues
+      description: Describe the current state of the documentation. What issues or gaps have you identified? Ex. "The current readme lacks examples for setting up..."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 📈 Proposed Changes
+      description: Detail the changes you propose. Include any specific wording, additional sections, or examples. If you have a draft, please include it here!
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 📚 Relevant Links and Resources
+      description: Provide any links to existing documentation, relevant GitHub issues, or other resources that support your suggestion.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 🤝 Additional Context
+      description: Add any other context or background that might help understand the need for this improvement. This could include user feedback, common questions, or confusion points.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Guidelines for contributing to Azure Review Checklists
+    url: https://github.com/Azure/review-checklists/blob/main/CONTRIBUTING.md
+    about: Anybody is welcome to contribute, regardless if you are a Microsoft employee, a Microsoft partner, or just using Azure.