issue and pr templates (dotnet#2929)

vvgonline · Mar 9, 2017 · a79c138 · a79c138
1 parent d2b516e
commit a79c138
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,22 @@
+## General
+
+We use issues to drive the discussion for changes to
+existing topics and the creation of new topics.
+This template offers some suggestions to consider
+when creating an issue.
+
+## Issues with Existing Topics
+
+If the issue is a simple typo or similar correction, just submit a PR.
+Otherwise, let us know what's wrong or what we should improve. Include a
+link to the topic.
+
+## Requests for new Topics
+
+1. Write a **short** paragraph describing what the topic will cover.
+
+2. Write an outline of the proposed topic contents.
+
+3. Where would you put the topic in the Table of Contents.
+
+4. If you know who should review the issue, notify them by including @githubID in the issue description.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+# Title
+
+Brief description of what this Pull Request (PR) does.
+
+## Summary
+
+Longer description if needed (if there's an issue for it,
+no need to copy the description from there).
+
+Fixes #Issue_Number
+
+> The "Fixes #nnn" syntax in the PR description causes
+> GitHub to automatically close the issue when this PR is merged.
+> Remove the "Fixes" line if no issue is associated with the PR.
+
+## Suggested Reviewers
+
+If you know who should review this PR, assign them using the GitHub **Reviewers** UI.