Skip to content

Commit

Permalink
[#6644] Enhancement: Make issue templates more readily accessible (#6647
Browse files Browse the repository at this point in the history
)
  • Loading branch information
wkurniawan07 authored Feb 24, 2017
1 parent d3a3688 commit b2f63c2
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 144 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
Search [the issue tracker][issue tracker] to ensure that there is no similar open issue.
If that is the case, [open a new issue][new issue]. Use the following templates:

* For feature requests, refer [here](../docs/template-featureRequest.md).
* For bug reports, refer [here](../docs/template-bugReport.md).
* For new contributor introduction, refer [here](../docs/template-contributorIntro.md).
* For help requests, refer [here](../docs/template-helpRequest.md).
* For other work like refactoring, updating documentation, or performance improvement, simply provide a clear **issue title** and **description** of the work to be done.
* For bug reports, refer [here](template-bugReport.md).
* For feature/enhancement requests, refer [here](template-featureRequest.md).
* For new contributor introduction, refer [here](template-contributorIntro.md).
* For help requests, refer [here](template-helpRequest.md).
* For other work like refactoring or updating documentation, simply provide a clear issue title and description of the work to be done.

[issue tracker]: https://github.com/TEAMMATES/teammates/issues
[new issue]: https://github.com/TEAMMATES/teammates/issues/new
Expand Down
10 changes: 7 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<!-- Before opening a new issue, please check that no existing issue covers the same topic
<!--
Before opening a new issue, please check that no existing issue covers the same topic.
Our contributing guidelines (link given above) contain some templates to be used when posting a new issue.
We encourage you to use them as appropriate.
Use the following templates for opening issues, where applicable:
1. For bug reports: https://github.com/TEAMMATES/teammates/blob/master/.github/template-bugReport.md
2. For feature/enhancement requests: https://github.com/TEAMMATES/teammates/blob/master/.github/template-featureRequest.md
3. For new contributor introduction: https://github.com/TEAMMATES/teammates/blob/master/.github/template-contributorIntro.md
4. For help requests: https://github.com/TEAMMATES/teammates/blob/master/.github/template-helpRequest.md
-->
18 changes: 18 additions & 0 deletions .github/template-bugReport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
**Issue Title:** Bug: [brief description of bug]

Copy-and-paste the following template to the issue tracker and fill it in with relevant details:
```markdown
**Environment**
<!-- The environment in which you encountered the bug, e.g. live server at `V5.93`, `master` branch at commit 1234567. -->


**Steps to reproduce**



**Expected behaviour**



**Actual behaviour**
```
14 changes: 14 additions & 0 deletions .github/template-contributorIntro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**Issue Title:** New Contributor Self-Intro: [your real name]

Copy-and-paste the following template to the issue tracker and fill it in with relevant details:
```markdown
- **Link to my app:** e.g. https://teammates-username.appspot.com
- **Link to my fork:** e.g. https://github.com/username/teammates

**Screenshot of changes made (as seen on the UI)**



**Short self-introduction**
<!-- Tell us more about yourself, e.g. your real name, your education background, why you want to contribute to TEAMMATES, etc. -->
```
17 changes: 17 additions & 0 deletions .github/template-featureRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
**Issue Title:** Feature: [your request in a line] OR Enhancement: [your suggestion in a line]

Copy-and-paste the following template to the issue tracker and fill it in with relevant details:
```markdown
**Description of feature/enhancement**



**Justification**
<!-- Explain who will benefit (instructors, students, developers, etc.) and in what way. -->



**Existing similar features and their shortcomings**
<!-- Explain why existing similar features fall short of your expectation. -->
<!-- This section can be skipped if there are no existing similar features. -->
```
19 changes: 19 additions & 0 deletions .github/template-helpRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
**Issue Title:** Help Request: [summary of your problem]

Copy-and-paste the following template to the issue tracker and fill it in with relevant details:
```markdown
- **Operating System:**
- **JDK Version:**
- **Eclipse Version:**
- **Firefox / Chrome Version (where applicable):**

**What I was trying to do / What I need help with**
<!-- e.g. if you were setting up the project, tell us the step in the setting up guide at which you are stuck. -->
<!-- e.g. if you were resolving test failures, tell us which tests are failing. -->
<!-- Include information such as screenshots, error stack traces, or console messages to help us troubleshoot. -->



**Attempts to resolve the problem**
<!-- Tell us the steps you have taken to try to (unsuccessfully) resolve the problem and the outcomes. -->
```
30 changes: 0 additions & 30 deletions docs/template-bugReport.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/template-contributorIntro.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/template-featureRequest.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/template-helpRequest.md

This file was deleted.

0 comments on commit b2f63c2

Please sign in to comment.