mirror of
https://github.com/wahyd4/github-issue-templates.git
synced 2026-08-08 20:25:36 +10:00
init
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
Issue tracker is **ONLY** used for reporting bugs. NO NEW FEATURE ACCEPTED! Use [stackoverflow](https://stackoverflow.com) for supporting issues.
|
||||
|
||||
<!--- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Expected Behavior
|
||||
<!--- Tell us what should happen -->
|
||||
|
||||
## Current Behavior
|
||||
<!--- Tell us what happens instead of the expected behavior -->
|
||||
|
||||
## Possible Solution
|
||||
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
|
||||
|
||||
## Steps to Reproduce
|
||||
<!--- 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 (Environment)
|
||||
<!--- 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 -->
|
||||
|
||||
<!--- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Detailed Description
|
||||
<!--- Provide a detailed description of the change or addition you are proposing -->
|
||||
|
||||
## Possible Implementation
|
||||
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
|
||||
@@ -0,0 +1,23 @@
|
||||
Bug Fixes **ONLY**. NO NEW FEATURE ACCEPTED!
|
||||
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Related Issue
|
||||
<!--- This project only accepts pull requests related to open issues -->
|
||||
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
|
||||
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
|
||||
<!--- Please link to the issue here: -->
|
||||
|
||||
## Motivation and Context
|
||||
<!--- Why is this change required? What problem does it solve? -->
|
||||
<!--- If it fixes an open issue, please link to the issue here. -->
|
||||
|
||||
## How Has This Been Tested?
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
||||
<!--- see how your change affects other areas of the code, etc. -->
|
||||
|
||||
## Screenshots (if appropriate):
|
||||
@@ -0,0 +1,17 @@
|
||||
# Please follow the general troubleshooting steps first:
|
||||
|
||||
- [ ] Ran ?
|
||||
- [ ] Ran ?
|
||||
- [ ] If you're seeing permission errors ?
|
||||
|
||||
<!-- You can erase any parts of this template not applicable to your Issue. -->
|
||||
|
||||
### Bug reports:
|
||||
|
||||
Please replace this line with a brief summary of your issue **AND** if reporting a build issue include the link from:
|
||||
|
||||
### Features:
|
||||
|
||||
**Please note by far the quickest way to get a new feature is to file a Pull Request.**
|
||||
|
||||
We will consider your request but it may be closed if it's something we're not actively planning to work on.
|
||||
@@ -0,0 +1,17 @@
|
||||
### All Submissions:
|
||||
|
||||
* [ ] Have you followed the guidelines in our Contributing document?
|
||||
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
|
||||
|
||||
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
|
||||
|
||||
### New Feature Submissions:
|
||||
|
||||
1. [ ] Does your submission pass tests?
|
||||
2. [ ] Have you lint your code locally prior to submission?
|
||||
|
||||
### Changes to Core Features:
|
||||
|
||||
* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
|
||||
* [ ] Have you written new tests for your core changes, as applicable?
|
||||
* [ ] Have you successfully ran tests with your changes locally?
|
||||
@@ -0,0 +1,28 @@
|
||||
### Prerequisites
|
||||
|
||||
* [ ] Can you reproduce the problem in safe mode?
|
||||
* [ ] Are you running the latest version?
|
||||
* [ ] Did you check the debugging guide?
|
||||
* [ ] Did you check the FAQs on Discuss?
|
||||
* [ ] Are you reporting to the correct repository?
|
||||
* [ ] Did you perform a cursory search?
|
||||
|
||||
For more information, see the `CONTRIBUTING` guide.
|
||||
|
||||
### Description
|
||||
|
||||
[Description of the bug or feature]
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
1. [First Step]
|
||||
2. [Second Step]
|
||||
3. [and so on...]
|
||||
|
||||
**Expected behavior:** [What you expected to happen]
|
||||
|
||||
**Actual behavior:** [What actually happened]
|
||||
|
||||
### Versions
|
||||
|
||||
You can get this information from executing `npm version`.
|
||||
@@ -0,0 +1,11 @@
|
||||
## Types of changes
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
- [ ] I have read the **CONTRIBUTING** document.
|
||||
- [ ] My code follows the code style of this project.
|
||||
- [ ] My change requires a change to the documentation.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I have added tests to cover my changes.
|
||||
- [ ] All new and existing tests passed.
|
||||
@@ -0,0 +1,38 @@
|
||||
**Note: for support questions, please use stackoverflow**. This repository's issues are reserved for feature requests and bug reports.
|
||||
|
||||
* **I'm submitting a ... **
|
||||
[ ] bug report
|
||||
[ ] feature request
|
||||
[ ] support request => Please do not submit support request here, see note at the top of this template.
|
||||
|
||||
|
||||
* **Do you want to request a *feature* or report a *bug*?**
|
||||
|
||||
|
||||
|
||||
* **What is the current behavior?**
|
||||
|
||||
|
||||
|
||||
* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** via
|
||||
https://plnkr.co or similar (you can use this template as a starting point: http://plnkr.co/edit/tpl:AvJOMERrnz94ekVua0u5).
|
||||
|
||||
|
||||
|
||||
* **What is the expected behavior?**
|
||||
|
||||
|
||||
|
||||
* **What is the motivation / use case for changing the behavior?**
|
||||
|
||||
|
||||
|
||||
* **Please tell us about your environment:**
|
||||
|
||||
- version: 2.0.0-beta.X
|
||||
- Browser: [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
|
||||
- Language: [all | TypeScript X.X | ES6/7 | ES5 | Dart]
|
||||
|
||||
|
||||
|
||||
* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
|
||||
@@ -0,0 +1,23 @@
|
||||
* **Please check if the PR fulfills these requirements**
|
||||
- [ ] The commit message follows our guidelines
|
||||
- [ ] Tests for the changes have been added (for bug fixes / features)
|
||||
- [ ] Docs have been added / updated (for bug fixes / features)
|
||||
|
||||
|
||||
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
|
||||
|
||||
|
||||
|
||||
* **What is the current behavior?** (You can also link to an open issue here)
|
||||
|
||||
|
||||
|
||||
* **What is the new behavior (if this is a feature change)?**
|
||||
|
||||
|
||||
|
||||
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
|
||||
|
||||
|
||||
|
||||
* **Other information**:
|
||||
@@ -0,0 +1,21 @@
|
||||
Hey there and thank you for using Issue Tracker!
|
||||
|
||||
Our project, as you've probably heard, is getting really popular and truth is we're getting a bit overwhelmed by the activity surrounding it. There are just too many issues for us to manage properly.
|
||||
|
||||
Do the checklist before filing an issue:
|
||||
|
||||
- [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome.
|
||||
- [ ] Have a usage question? Ask your question on [StackOverflow](http://stackoverflow.com). We use StackOverflow for usage question and GitHub for bugs.
|
||||
- [ ] Have an idea for a feature? Post the feature request on Product Pains. It has a voting system to surface the important issues. GitHub issues should only be used for bugs.
|
||||
|
||||
|
||||
None of the above, create a bug report
|
||||
------------------------------------------------------------------
|
||||
|
||||
Make sure to add **all the information needed to understand the bug** so that someone can help. If the info is missing we'll add the 'Needs more information' label and close the issue until there is enough information.
|
||||
|
||||
- [ ] Provide a **minimal code snippet** / [rnplay](https://rnplay.org/) example that reproduces the bug.
|
||||
- [ ] Provide **screenshots** where appropriate
|
||||
- [ ] What's the **version** of React Native you're using?
|
||||
- [ ] Does this occur on iOS, Android or both?
|
||||
- [ ] Are you using Mac, Linux or Windows?
|
||||
@@ -0,0 +1,25 @@
|
||||
Please do not create a Pull Request without creating an issue first.
|
||||
Any change needs to be discussed before proceeding.
|
||||
Failure to do so may result in the rejection of the pull request.
|
||||
|
||||
Please provide enough information so that others can review your pull request:
|
||||
|
||||
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
|
||||
|
||||
Explain the **details** for making this change. What existing problem does the pull request solve?
|
||||
|
||||
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
|
||||
|
||||
**Test plan (required)**
|
||||
|
||||
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
|
||||
|
||||
<!-- Make sure tests pass on both Travis and Circle CI. -->
|
||||
|
||||
**Code formatting**
|
||||
|
||||
<!-- See the simple style guide. -->
|
||||
|
||||
**Closing issues**
|
||||
|
||||
Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
|
||||
@@ -0,0 +1,33 @@
|
||||
Your issue may already be reported!
|
||||
Please search on the [issue track](../) before creating one.
|
||||
|
||||
## 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 -->
|
||||
* Version used:
|
||||
* Browser Name and version:
|
||||
* Operating System and version (desktop or mobile):
|
||||
* Link to your project:
|
||||
@@ -0,0 +1,40 @@
|
||||
A similar PR may already be submitted!
|
||||
Please search among the [Pull request](../) before creating one.
|
||||
|
||||
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
|
||||
|
||||
For more information, see the `CONTRIBUTING` guide.
|
||||
|
||||
|
||||
**Summary**
|
||||
|
||||
<!-- Summary of the PR -->
|
||||
|
||||
This PR fixes/implements the following **bugs/features**
|
||||
|
||||
* [ ] Bug 1
|
||||
* [ ] Bug 2
|
||||
* [ ] Feature 1
|
||||
* [ ] Feature 2
|
||||
* [ ] Breaking changes
|
||||
|
||||
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
|
||||
|
||||
Explain the **motivation** for making this change. What existing problem does the pull request solve?
|
||||
|
||||
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
|
||||
|
||||
**Test plan (required)**
|
||||
|
||||
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
|
||||
|
||||
<!-- Make sure tests pass on both Travis and Circle CI. -->
|
||||
|
||||
**Code formatting**
|
||||
|
||||
<!-- See the simple style guide. -->
|
||||
|
||||
**Closing issues**
|
||||
|
||||
<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
|
||||
Fixes #
|
||||
@@ -0,0 +1,22 @@
|
||||
## *Who* is the bug affecting?
|
||||
<!-- Ex. All supervisors, Sally Supervisor, Level 1 CCs -->
|
||||
|
||||
## *What* is affected by this bug?
|
||||
<!-- Ex. supervision, sending messages, texter profiles -->
|
||||
|
||||
## *When* does this occur?
|
||||
<!-- Ex. After ending a conversation, every night at 3pm, when I sign off -->
|
||||
|
||||
## *Where* on the platform does it happen?
|
||||
<!-- Ex. In the a Supervisor chat box, on the conversation profile page, on the two-factor screen -->
|
||||
|
||||
|
||||
## *How* do we replicate the issue?
|
||||
<!-- Please be specific as possible. Use dashes (-) or numbers (1.) to create a list of steps -->
|
||||
|
||||
|
||||
## Expected behavior (i.e. solution)
|
||||
<!-- What should have happened? -->
|
||||
|
||||
|
||||
##Other Comments
|
||||
@@ -0,0 +1,28 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Motivation and Context
|
||||
<!--- Why is this change required? What problem does it solve? -->
|
||||
<!--- If it fixes an open issue, please link to the issue here. -->
|
||||
|
||||
## How Has This Been Tested?
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, tests ran to see how -->
|
||||
<!--- your change affects other areas of the code, etc. -->
|
||||
|
||||
## Screenshots (if appropriate):
|
||||
|
||||
## Types of changes
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
|
||||
## Checklist:
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] My code follows the code style of this project.
|
||||
- [ ] My change requires a change to the documentation.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
@@ -0,0 +1,11 @@
|
||||
# GitHub issue templates
|
||||
|
||||
> A collection of GitHub issue and pull request templates
|
||||
|
||||
GitHub finally supports [issue template](https://github.com/blog/2111-issue-and-pull-request-templates).
|
||||
|
||||
# 10+ templates for you to pick!
|
||||
|
||||
Find your issue/PR templates, and just grab and go.
|
||||
|
||||
Inspired by Excellent GitHub projects.
|
||||
@@ -0,0 +1,13 @@
|
||||
### Issue and Steps to Reproduce
|
||||
<!-- Describe your issue and tell us how to reproduce it (include any useful information). -->
|
||||
|
||||
### Versions
|
||||
|
||||
### Screenshots
|
||||
|
||||
#### Expected
|
||||
|
||||
#### Actual
|
||||
|
||||
### Additional Details
|
||||
* Installed packages:
|
||||
@@ -0,0 +1,5 @@
|
||||
## A picture tells a thousand words
|
||||
|
||||
## Before this PR
|
||||
|
||||
## After this PR
|
||||
Executable
+17
@@ -0,0 +1,17 @@
|
||||
## Expected Behavior
|
||||
|
||||
|
||||
## Actual Behavior
|
||||
|
||||
|
||||
## Steps to Reproduce the Problem
|
||||
|
||||
1.
|
||||
1.
|
||||
1.
|
||||
|
||||
## Specifications
|
||||
|
||||
- Version:
|
||||
- Platform:
|
||||
- Subsystem:
|
||||
Executable
+7
@@ -0,0 +1,7 @@
|
||||
Fixes #
|
||||
|
||||
## Proposed Changes
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
@@ -0,0 +1,24 @@
|
||||
<!--
|
||||
Issue template
|
||||
To Use this Template:
|
||||
* Fill out what you can
|
||||
* Delete what you do not fill out
|
||||
-->
|
||||
|
||||
NOTE: ISSUES ARE NOT FOR CODE HELP - Ask for Help at https://stackoverflow.com
|
||||
|
||||
#### Issue Description
|
||||
* When Issue Happens
|
||||
* Steps To Reproduce
|
||||
|
||||
#### Browser Information
|
||||
* Browser Name, Version
|
||||
* Operating System
|
||||
|
||||
#### Your Code
|
||||
|
||||
```js
|
||||
If relevant, paste all of your challenge code in here
|
||||
```
|
||||
|
||||
#### Screenshot
|
||||
@@ -0,0 +1,27 @@
|
||||
## Pull Request template
|
||||
Please, go through these steps before you submit a PR.
|
||||
|
||||
1. Make sure that your PR is not a duplicate.
|
||||
2. If not, then make sure that:
|
||||
|
||||
2.1. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`.
|
||||
|
||||
2.2. You have a descriptive commit message with a short title (first line).
|
||||
|
||||
2.3. You have only one commit (if not, squash them into one commit).
|
||||
|
||||
2.4. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`).
|
||||
|
||||
3. **After** these steps, you're ready to open a pull request.
|
||||
|
||||
3.1. Your pull request MUST NOT target the `master` branch on this repository. You probably want to target `staging` instead.
|
||||
|
||||
3.2. Give a descriptive title to your PR.
|
||||
|
||||
3.3. Provide a description of your changes.
|
||||
|
||||
3.4. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
|
||||
|
||||
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
|
||||
|
||||
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**
|
||||
@@ -0,0 +1,16 @@
|
||||
<!--
|
||||
Thanks for wanting to report an issue you've found. Please delete
|
||||
this text and fill in the template below. If unsure about something, just do as
|
||||
best as you're able.
|
||||
|
||||
Note that it will be much easier for us to fix the issue if a test case that
|
||||
reproduces the problem is provided. Ideally this test case should not have any
|
||||
external dependencies. We understand that it is not always possible to reduce
|
||||
your code to a small test case, but we would appreciate to have as much data as
|
||||
possible. Thank you!
|
||||
-->
|
||||
|
||||
* **Version**: <!-- compulsory. you must provide your version -->
|
||||
* **Platform**: <!-- either `uname -a` output, or if Windows, version and 32-bit or
|
||||
64-bit -->
|
||||
* **Subsystem**: <!-- optional. if known - please specify affected core module name -->
|
||||
@@ -0,0 +1,20 @@
|
||||
### Pull Request check-list
|
||||
|
||||
_Please make sure to review and check all of these items:_
|
||||
|
||||
- [ ] Does UNIX or Windows pass with
|
||||
this change (including linting)?
|
||||
- [ ] Is the commit message formatted according to CONTRIBUTING.md?
|
||||
- [ ] If this change fixes a bug (or a performance problem), is a regression
|
||||
test (or a benchmark) included?
|
||||
- [ ] Is a documentation update included (if this change modifies
|
||||
existing APIs, or introduces new ones)?
|
||||
|
||||
_NOTE: these things are not required to open a PR and can be done
|
||||
afterwards / while the PR is open._
|
||||
|
||||
### Affected core subsystem(s)
|
||||
<!-- Please provide affected core subsystem(s). -->
|
||||
|
||||
### Description of change
|
||||
<!-- Please provide a description of the change here. -->
|
||||
Reference in New Issue
Block a user