Merge pull request #638 from darrenvechain/github-templates

GitHub templates

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,66 @@
+name: "🐛 Bug Report"
+description: Create a new ticket for a bug.
+title: "🐛 [BUG] - <title>"
+labels: [
+"bug"
+]
+body:
+- type: textarea
+  id: description
+  attributes:
+  label: "Description"
+  description: Please enter an explicit description of your issue
+  placeholder: Short and explicit description of your incident...
+  validations:
+  required: true
+- type: input
+  id: reprod-url
+  attributes:
+  label: "Reproduction URL"
+  description: Please enter your GitHub URL to provide a reproduction of the issue
+  placeholder: ex. https://github.com/USERNAME/REPO-NAME
+  validations:
+  required: true
+- type: textarea
+  id: reprod
+  attributes:
+  label: "Reproduction steps"
+  description: Please enter an explicit description of your issue
+  value: |
+  1. Go to '...'
+  2. Click on '....'
+  3. Scroll down to '....'
+  4. See error
+  render: bash
+  validations:
+  required: true
+- type: textarea
+  id: screenshot
+  attributes:
+  label: "Screenshots"
+  description: If applicable, add screenshots to help explain your problem.
+  value: |
+  ![DESCRIPTION](LINK.png)
+  render: bash
+  validations:
+  required: false
+- type: textarea
+  id: logs
+  attributes:
+  label: "Logs"
+  description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+  render: bash
+  validations:
+  required: false
+- type: dropdown
+  id: os
+  attributes:
+  label: "OS"
+  description: What is the impacted environment ?
+  multiple: true
+  options:
+  - Windows
+  - Linux
+  - Mac
+  validations:
+  required: false

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,63 @@
+name: "💡 Feature Request"
+description: Create a new ticket for a new feature request. Please refer to the [VeChain Improvement Proposals (VIP)](https://github.com/vechain/VIPs) process for more information on feature requests.
+title: "💡 [REQUEST] - <title>"
+labels: [
+"question"
+]
+body:
+- type: input
+  id: start_date
+  attributes:
+  label: "Start Date"
+  description: Start of development
+  placeholder: "month/day/year"
+  validations:
+  required: false
+- type: textarea
+  id: implementation_pr
+  attributes:
+  label: "Implementation PR"
+  description: Pull request used
+  placeholder: "#Pull Request ID"
+  validations:
+  required: false
+- type: textarea
+  id: reference_issues
+  attributes:
+  label: "Reference Issues"
+  description: Common issues
+  placeholder: "#Issues IDs"
+  validations:
+  required: false
+- type: textarea
+  id: summary
+  attributes:
+  label: "Summary"
+  description: Provide a brief explanation of the feature
+  placeholder: Describe in a few lines your feature request
+  validations:
+  required: true
+- type: textarea
+  id: basic_example
+  attributes:
+  label: "Basic Example"
+  description: Indicate here some basic examples of your feature.
+  placeholder: A few specific words about your feature request.
+  validations:
+  required: true
+- type: textarea
+  id: drawbacks
+  attributes:
+  label: "Drawbacks"
+  description: What are the drawbacks/impacts of your feature request ?
+  placeholder: Identify the drawbacks and impacts while being neutral on your feature request
+  validations:
+  required: true
+- type: textarea
+  id: unresolved_question
+  attributes:
+  label: "Unresolved questions"
+  description: What questions still remain unresolved ?
+  placeholder: Identify any unresolved issues.
+  validations:
+  required: false

.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md

@@ -0,0 +1,39 @@
+# Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* Go Version:
+* Hardware:
+* Docker Version:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] New and existing E2E tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have not added any vulnerable dependencies to my code