Skip to content
This repository was archived by the owner on Dec 15, 2022. It is now read-only.

Commit 0cac613

Browse files
authored
Merge pull request #473 from atom/template-update
Update issue and PR templates
2 parents 87bb934 + ba6ca75 commit 0cac613

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

ISSUE_TEMPLATE.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--
2+
3+
Have you read Atom's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/atom/atom/blob/master/CODE_OF_CONDUCT.md
4+
5+
Do you want to ask a question? Are you looking for support? The Atom message board is the best place for getting support: https://discuss.atom.io
6+
7+
-->
8+
9+
### Prerequisites
10+
11+
* [ ] Put an X between the brackets on this line if you have done all of the following:
12+
* Reproduced the problem in Safe Mode: http://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode
13+
* Followed all applicable steps in the debugging guide: http://flight-manual.atom.io/hacking-atom/sections/debugging/
14+
* Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq
15+
* Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom
16+
* Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages
17+
18+
### Description
19+
20+
[Description of the issue]
21+
22+
### Steps to Reproduce
23+
24+
1. [First Step]
25+
2. [Second Step]
26+
3. [and so on...]
27+
28+
**Expected behavior:** [What you expect to happen]
29+
30+
**Actual behavior:** [What actually happens]
31+
32+
**Reproduces how often:** [What percentage of the time does it reproduce?]
33+
34+
### Versions
35+
36+
You can get this information from copy and pasting the output of `atom --version` and `apm --version` from the command line. Also, please include the OS and what version of the OS you're running.
37+
38+
### Additional Information
39+
40+
Any additional information, configuration or data that might be necessary to reproduce the issue.

PULL_REQUEST_TEMPLATE.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
### Requirements
2+
3+
* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
4+
* All new code requires tests to ensure against regressions
5+
6+
### Description of the Change
7+
8+
<!--
9+
10+
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
11+
12+
-->
13+
14+
## Alternate Designs
15+
16+
<!-- Explain what other alternates were considered and why the proposed version was selected -->
17+
18+
### Benefits
19+
20+
<!-- What benefits will be realized by the code change? -->
21+
22+
### Possible Drawbacks
23+
24+
<!-- What are the possible side-effects or negative impacts of the code change? -->
25+
26+
### Applicable Issues
27+
28+
<!-- Enter any applicable Issues here -->

0 commit comments

Comments
 (0)