Skip to content

Commit fb2e844

Browse files
authoredJul 12, 2016
create issue and pull request template. (dotnet#765)
* Initial draft of issue and pull request template. These will provide guidance when someone creates a new issue, or a new pull request respectively. * reference CONTRIBUTING.md in issue * Update based on feedback First cycle of feedback * move files to .github directory * update from feedback * Respond to feedback. Trying to simply both templates as much as possible. * Updates based on @tdykstra review * Updates from final review
1 parent 75cd0c2 commit fb2e844

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed
 

‎.github/ISSUE_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Issue Title
2+
3+
Be as descriptive as you can with your title. If your issue requests
4+
a new topic, preface the title with [NewTopic].
5+
6+
# General
7+
8+
We use issues to drive the discussion for changes to
9+
existing topics and the creation of new topics.
10+
11+
This way, we have those discussions before significant
12+
effort is spent writing a new topic. Click on the Guidelines
13+
for Contributing link above for details.
14+
15+
## Issues with Existing Topics
16+
17+
If the issue is a simple typo or similar correction, you can just submit a PR.
18+
Otherwise, let us know what's wrong or what we should improve. Include a
19+
link to the topic.
20+
21+
## Requests for new Topics
22+
23+
1. Tell us where this topic should go in the Table of Contents.
24+
25+
- Consider where you looked for this information before opening an issue.
26+
27+
2. Write an abstract
28+
29+
- In one **short** paragraph, describe what this topic will cover.
30+
31+
3. Fill in an outline
32+
33+
- Write a complete outline for the new topic. We'll help review the outline and approve that before anyone writes a topic.
34+
35+
4. Suggest reviewers
36+
37+
- If you know someone who can provide feedback, use '@' to ask them to review.

‎.github/PULL_REQUEST_TEMPLATE.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Title
2+
3+
On the title describe
4+
what you've fixed (or created) with this Pull Request (PR).
5+
6+
## Summary
7+
8+
Insert a short (one or two sentence) summary here.
9+
10+
Fixes #Issue_Number
11+
12+
>Note: The "Fixes #nnn" syntax in the PR description causes
13+
>GitHub to automatically close the issue when this PR is merged.
14+
> Remove that line if you don't have issues associated with this
15+
> PR. Click on the Guidelines for Contributing link above for details.
16+
17+
## Details
18+
19+
Explain your changes, and why you made them. If that
20+
information is already available in the issue referenced
21+
above, just referencing the issue is preferred to copying
22+
the text.
23+
24+
This may not be necessary depending on the scope of the PR
25+
changes. For example, "fix typo in introduction.md" is
26+
sufficient to describe that PR.
27+
28+
## Suggested Reviewers
29+
30+
If you know who should review this, use '@' to request a review.

0 commit comments

Comments
 (0)
Please sign in to comment.