Ver Fonte

Add templates for PRs/Issues

Tom Denham há 7 anos atrás
pai
commit
0e65fd8b5d
2 ficheiros alterados com 47 adições e 0 exclusões
  1. 35 0
      .github/ISSUE_TEMPLATE.md
  2. 12 0
      .github/PULL_REQUEST_TEMPLATE.md

+ 35 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,35 @@
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Flannel version:
+* Backend used (e.g. vxlan or udp):
+* Etcd version:
+* Kubernetes version (if used):
+* Operating System and version:
+* Link to your project (optional):
+

+ 12 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Description
+A few sentences describing the overall goals of the pull request's commits. 
+Please include 
+- the type of fix - (e.g. bug fix, new feature, documentation)
+- some details on _why_ this PR should be merged
+- the details of the testing you've done on it (both manual and automated)
+- which components are affected by this PR
+
+## Todos
+- [ ] Tests
+- [ ] Documentation
+