├── .github ├── CONTRIBUTING.md └── ISSUE_TEMPLATE │ ├── BUG-REPORT.yml │ ├── FEATURE-REQUEST.yml │ └── config.yml ├── .vscode └── settings.json ├── LICENSE.md ├── bugs-only ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── checklist ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── checklist2 ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── conversational ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── emoji-guide ├── Bug_report.md ├── Feature_request.md ├── Regression-v7.md ├── Support_question.md └── Support_us.md ├── must-open-issue-before-pr ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── no-duplicates ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── questions-answers ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── readme.md ├── screenshots ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── simple ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── squash-commits ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md └── system ├── ISSUE_TEMPLATE.md ├── ISSUE_TEMPLATE ├── 1-bug-report.md ├── 2-feature-request.md ├── 3-help.md └── 4-nodejs-org.md └── PULL_REQUEST_TEMPLATE.md /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | ## Request for changes/ Pull Requests 4 | You first need to create a fork of the [github-issue-template](https://github.com/stevemao/github-issue-templates/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). 5 | 6 | Then add your fork as a local project: 7 | 8 | ```sh 9 | # Using HTTPS 10 | git clone https://github.com/stevemao/github-issue-templates.git 11 | 12 | # Using SSH 13 | git clone git@github.com:stevemao/github-issue-templates.git 14 | ``` 15 | 16 | > [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories) 17 | 18 | Then, go to your local folder 19 | 20 | ```sh 21 | cd github-issue-template 22 | ``` 23 | 24 | Add git remote controls : 25 | 26 | ```sh 27 | # Using HTTPS 28 | git remote add fork https://github.com/YOUR-USERNAME/github-issue-templates.git 29 | git remote add upstream https://github.com/stevemao/github-issue-templates.git 30 | 31 | 32 | # Using SSH 33 | git remote add fork git@github.com:YOUR-USERNAME/github-issue-templates.git 34 | git remote add upstream git@github.com/stevemao/github-issue-templates.git 35 | ``` 36 | 37 | You can now verify that you have your two git remotes: 38 | 39 | ```sh 40 | git remote -v 41 | ``` 42 | 43 | ## Receive remote updates 44 | In view of staying up to date with the central repository : 45 | 46 | ```sh 47 | git pull upstream master 48 | ``` 49 | 50 | ## Choose a base branch 51 | Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use master. 52 | 53 | | Type of change | | Branches | 54 | | :------------------ |:---------:| ---------------------:| 55 | | Documentation | | `master` | 56 | | Bug fixes | | `master` | 57 | | New features | | `master` | 58 | | New issues models | | `YOUR-USERNAME:patch` | 59 | 60 | ```sh 61 | # Switch to the desired branch 62 | git switch master 63 | 64 | # Pull down any upstream changes 65 | git pull 66 | 67 | # Create a new branch to work on 68 | git switch --create patch/1234-name-issue 69 | ``` 70 | 71 | Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the Github-issue-templates repository](https://github.com/stevemao/github-issue-templates/) following the template provided. -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/BUG-REPORT.yml: -------------------------------------------------------------------------------- 1 | name: "🐛 Bug Report" 2 | description: Create a new ticket for a bug. 3 | title: "🐛 [BUG] - " 4 | labels: [ 5 | "bug" 6 | ] 7 | body: 8 | - type: textarea 9 | id: description 10 | attributes: 11 | label: "Description" 12 | description: Please enter an explicit description of your issue 13 | placeholder: Short and explicit description of your incident... 14 | validations: 15 | required: true 16 | - type: input 17 | id: reprod-url 18 | attributes: 19 | label: "Reproduction URL" 20 | description: Please enter your GitHub URL to provide a reproduction of the issue 21 | placeholder: ex. https://github.com/USERNAME/REPO-NAME 22 | validations: 23 | required: true 24 | - type: textarea 25 | id: reprod 26 | attributes: 27 | label: "Reproduction steps" 28 | description: Please enter an explicit description of your issue 29 | value: | 30 | 1. Go to '...' 31 | 2. Click on '....' 32 | 3. Scroll down to '....' 33 | 4. See error 34 | render: bash 35 | validations: 36 | required: true 37 | - type: textarea 38 | id: screenshot 39 | attributes: 40 | label: "Screenshots" 41 | description: If applicable, add screenshots to help explain your problem. 42 | value: | 43 | ![DESCRIPTION](LINK.png) 44 | render: bash 45 | validations: 46 | required: false 47 | - type: textarea 48 | id: logs 49 | attributes: 50 | label: "Logs" 51 | description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. 52 | render: bash 53 | validations: 54 | required: false 55 | - type: dropdown 56 | id: browsers 57 | attributes: 58 | label: "Browsers" 59 | description: What browsers are you seeing the problem on ? 60 | multiple: true 61 | options: 62 | - Firefox 63 | - Chrome 64 | - Safari 65 | - Microsoft Edge 66 | - Opera 67 | validations: 68 | required: false 69 | - type: dropdown 70 | id: os 71 | attributes: 72 | label: "OS" 73 | description: What is the impacted environment ? 74 | multiple: true 75 | options: 76 | - Windows 77 | - Linux 78 | - Mac 79 | validations: 80 | required: false -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml: -------------------------------------------------------------------------------- 1 | name: "💡 Feature Request" 2 | description: Create a new ticket for a new feature request 3 | title: "💡 [REQUEST] - <title>" 4 | labels: [ 5 | "question" 6 | ] 7 | body: 8 | - type: input 9 | id: start_date 10 | attributes: 11 | label: "Start Date" 12 | description: Start of development 13 | placeholder: "month/day/year" 14 | validations: 15 | required: false 16 | - type: textarea 17 | id: implementation_pr 18 | attributes: 19 | label: "Implementation PR" 20 | description: Pull request used 21 | placeholder: "#Pull Request ID" 22 | validations: 23 | required: false 24 | - type: textarea 25 | id: reference_issues 26 | attributes: 27 | label: "Reference Issues" 28 | description: Common issues 29 | placeholder: "#Issues IDs" 30 | validations: 31 | required: false 32 | - type: textarea 33 | id: summary 34 | attributes: 35 | label: "Summary" 36 | description: Provide a brief explanation of the feature 37 | placeholder: Describe in a few lines your feature request 38 | validations: 39 | required: true 40 | - type: textarea 41 | id: basic_example 42 | attributes: 43 | label: "Basic Example" 44 | description: Indicate here some basic examples of your feature. 45 | placeholder: A few specific words about your feature request. 46 | validations: 47 | required: true 48 | - type: textarea 49 | id: drawbacks 50 | attributes: 51 | label: "Drawbacks" 52 | description: What are the drawbacks/impacts of your feature request ? 53 | placeholder: Identify the drawbacks and impacts while being neutral on your feature request 54 | validations: 55 | required: true 56 | - type: textarea 57 | id: unresolved_question 58 | attributes: 59 | label: "Unresolved questions" 60 | description: What questions still remain unresolved ? 61 | placeholder: Identify any unresolved issues. 62 | validations: 63 | required: false -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "nuxt.isNuxtApp": false 3 | } -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | To the extent possible under law, [Steve Mao](https://github.com/stevemao) has waived all copyright and related or neighboring rights to this work. 2 | -------------------------------------------------------------------------------- /bugs-only/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Issue tracker is **ONLY** used for reporting bugs. New features should be discussed on our slack channel. Please use [stackoverflow](https://stackoverflow.com) for supporting issues. 2 | 3 | <!--- Provide a general summary of the issue in the Title above --> 4 | 5 | ## Expected Behavior 6 | <!--- Tell us what should happen --> 7 | 8 | ## Current Behavior 9 | <!--- Tell us what happens instead of the expected behavior --> 10 | 11 | ## Possible Solution 12 | <!--- Not obligatory, but suggest a fix/reason for the bug, --> 13 | 14 | ## Steps to Reproduce 15 | <!--- Provide a link to a live example, or an unambiguous set of steps to --> 16 | <!--- reproduce this bug. Include code to reproduce, if relevant --> 17 | 1. 18 | 2. 19 | 3. 20 | 4. 21 | 22 | ## Context (Environment) 23 | <!--- How has this issue affected you? What are you trying to accomplish? --> 24 | <!--- Providing context helps us come up with a solution that is most useful in the real world --> 25 | 26 | <!--- Provide a general summary of the issue in the Title above --> 27 | 28 | ## Detailed Description 29 | <!--- Provide a detailed description of the change or addition you are proposing --> 30 | 31 | ## Possible Implementation 32 | <!--- Not obligatory, but suggest an idea for implementing addition or change --> 33 | -------------------------------------------------------------------------------- /bugs-only/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | THIS PROJECT IS IN MAINTENANCE MODE. We accept pull-requests for Bug Fixes **ONLY**. NO NEW FEATURES ACCEPTED! 2 | 3 | <!--- Provide a general summary of your changes in the Title above --> 4 | 5 | ## Description 6 | <!--- Describe your changes in detail --> 7 | 8 | ## Related Issue 9 | <!--- This project only accepts pull requests related to open issues --> 10 | <!--- If suggesting a new feature or change, please discuss it in an issue first --> 11 | <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> 12 | <!--- Please link to the issue here: --> 13 | 14 | ## Motivation and Context 15 | <!--- Why is this change required? What problem does it solve? --> 16 | <!--- If it fixes an open issue, please link to the issue here. --> 17 | 18 | ## How Has This Been Tested? 19 | <!--- Please describe in detail how you tested your changes. --> 20 | <!--- Include details of your testing environment, and the tests you ran to --> 21 | <!--- see how your change affects other areas of the code, etc. --> 22 | 23 | ## Screenshots (if appropriate): 24 | -------------------------------------------------------------------------------- /checklist/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Please follow the general troubleshooting steps first: 2 | 3 | - [ ] Ran ? 4 | - [ ] Ran ? 5 | - [ ] If you're seeing permission errors ? 6 | 7 | <!-- You can erase any parts of this template not applicable to your Issue. --> 8 | 9 | ### Bug reports: 10 | 11 | Please replace this line with a brief summary of your issue **AND** if reporting a build issue include the link from: 12 | 13 | ### Features: 14 | 15 | **Please note by far the quickest way to get a new feature is to file a Pull Request.** 16 | 17 | We will consider your request but it may be closed if it's something we're not actively planning to work on. 18 | -------------------------------------------------------------------------------- /checklist/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### All Submissions: 2 | 3 | * [ ] Have you followed the guidelines in our Contributing document? 4 | * [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? 5 | 6 | <!-- You can erase any parts of this template not applicable to your Pull Request. --> 7 | 8 | ### New Feature Submissions: 9 | 10 | 1. [ ] Does your submission pass tests? 11 | 2. [ ] Have you lint your code locally prior to submission? 12 | 13 | ### Changes to Core Features: 14 | 15 | * [ ] Have you added an explanation of what your changes do and why you'd like us to include them? 16 | * [ ] Have you written new tests for your core changes, as applicable? 17 | * [ ] Have you successfully ran tests with your changes locally? 18 | -------------------------------------------------------------------------------- /checklist2/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Prerequisites 2 | 3 | * [ ] Can you reproduce the problem in safe mode? 4 | * [ ] Are you running the latest version? 5 | * [ ] Did you check the debugging guide? 6 | * [ ] Did you check the FAQs on Discuss? 7 | * [ ] Are you reporting to the correct repository? 8 | * [ ] Did you perform a cursory search? 9 | 10 | For more information, see the `CONTRIBUTING` guide. 11 | 12 | ### Description 13 | 14 | [Description of the bug or feature] 15 | 16 | ### Steps to Reproduce 17 | 18 | 1. [First Step] 19 | 2. [Second Step] 20 | 3. [and so on...] 21 | 22 | **Expected behavior:** [What you expected to happen] 23 | 24 | **Actual behavior:** [What actually happened] 25 | 26 | ### Versions 27 | 28 | You can get this information from executing `npm version`. 29 | -------------------------------------------------------------------------------- /checklist2/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Types of changes 2 | <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> 3 | - [ ] Bug fix (non-breaking change which fixes an issue) 4 | - [ ] New feature (non-breaking change which adds functionality) 5 | - [ ] Breaking change (fix or feature that would cause existing functionality to change) 6 | - [ ] I have read the **CONTRIBUTING** document. 7 | - [ ] My code follows the code style of this project. 8 | - [ ] My change requires a change to the documentation. 9 | - [ ] I have updated the documentation accordingly. 10 | - [ ] I have added tests to cover my changes. 11 | - [ ] All new and existing tests passed. 12 | -------------------------------------------------------------------------------- /conversational/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | **Note: for support questions, please use stackoverflow**. This repository's issues are reserved for feature requests and bug reports. 2 | 3 | * **I'm submitting a ...** 4 | - [ ] bug report 5 | - [ ] feature request 6 | - [ ] support request => Please do not submit support request here, see note at the top of this template. 7 | 8 | 9 | * **Do you want to request a *feature* or report a *bug*?** 10 | 11 | 12 | 13 | * **What is the current behavior?** 14 | 15 | 16 | 17 | * **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** via 18 | https://plnkr.co or similar (you can use this template as a starting point: http://plnkr.co/edit/tpl:AvJOMERrnz94ekVua0u5). 19 | 20 | 21 | 22 | * **What is the expected behavior?** 23 | 24 | 25 | 26 | * **What is the motivation / use case for changing the behavior?** 27 | 28 | 29 | 30 | * **Please tell us about your environment:** 31 | 32 | - Version: 2.0.0-beta.X 33 | - 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 ] 34 | - Language: [all | TypeScript X.X | ES6/7 | ES5 | Dart] 35 | 36 | 37 | * **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) 38 | -------------------------------------------------------------------------------- /conversational/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | * **Please check if the PR fulfills these requirements** 2 | - [ ] The commit message follows our guidelines 3 | - [ ] Tests for the changes have been added (for bug fixes / features) 4 | - [ ] Docs have been added / updated (for bug fixes / features) 5 | 6 | 7 | * **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) 8 | 9 | 10 | 11 | * **What is the current behavior?** (You can also link to an open issue here) 12 | 13 | 14 | 15 | * **What is the new behavior (if this is a feature change)?** 16 | 17 | 18 | 19 | * **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) 20 | 21 | 22 | 23 | * **Other information**: 24 | -------------------------------------------------------------------------------- /emoji-guide/Bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F41B Bug Report" 3 | about: "If something isn't working as expected \U0001F914." 4 | title: '' 5 | labels: 'i: bug, i: needs triage' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Bug Report 11 | 12 | **Current Behavior** 13 | A clear and concise description of the behavior. 14 | 15 | **Input Code** 16 | - REPL or Repo link if applicable: 17 | 18 | ```js 19 | var your => (code) => here; 20 | ``` 21 | 22 | **Expected behavior/code** 23 | A clear and concise description of what you expected to happen (or code). 24 | 25 | **Babel Configuration (.babelrc, package.json, cli command)** 26 | 27 | ```js 28 | { 29 | "your": { "config": "here" } 30 | } 31 | ``` 32 | 33 | **Environment** 34 | - Babel version(s): [e.g. v6.0.0, v7.0.0-beta.34] 35 | - Node/npm version: [e.g. Node 8/npm 5] 36 | - OS: [e.g. OSX 10.13.4, Windows 10] 37 | - Monorepo: [e.g. yes/no/Lerna] 38 | - How you are using Babel: [e.g. `cli`, `register`, `loader`] 39 | 40 | **Possible Solution** 41 | <!--- Only if you have suggestions on a fix for the bug --> 42 | 43 | **Additional context/Screenshots** 44 | Add any other context about the problem here. If applicable, add screenshots to help explain. 45 | -------------------------------------------------------------------------------- /emoji-guide/Feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F680 Feature Request" 3 | about: "I have a suggestion (and may want to implement it \U0001F642)!" 4 | title: '' 5 | labels: 'i: enhancement, i: needs triage' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Feature Request 11 | 12 | **Is your feature request related to a problem? Please describe.** 13 | A clear and concise description of what the problem is. Ex. I have an issue when [...] 14 | 15 | **Describe the solution you'd like** 16 | A clear and concise description of what you want to happen. Add any considered drawbacks. 17 | 18 | **Describe alternatives you've considered** 19 | A clear and concise description of any alternative solutions or features you've considered. 20 | 21 | **Teachability, Documentation, Adoption, Migration Strategy** 22 | If you can, explain how users will be able to use this and possibly write out a version the docs. 23 | Maybe a screenshot or design? 24 | -------------------------------------------------------------------------------- /emoji-guide/Regression-v7.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F4A5 v7 Regression" 3 | about: Report an unexpected behavior in v7 from v6 (Check the upgrade guide first 4 | ✌️) 5 | title: '' 6 | labels: 'i: bug, 7.x: regression, i: needs triage' 7 | assignees: '' 8 | 9 | --- 10 | 11 | # v7 Regression 12 | 13 | > First check out: https://babeljs.io/docs/en/v7-migration 14 | > Also a partial upgrade tool: https://github.com/babel/babel-upgrade 15 | 16 | **Potential Commit/PR that introduced the regression** 17 | If you have time to investigate, what PR/date introduced this issue. 18 | 19 | **Describe the regression** 20 | A clear and concise description of what the regression is. 21 | 22 | **Input Code** 23 | <!--- If you have link to our REPL or a standalone repo please link that! --> 24 | 25 | ```js 26 | var your => (code) => here; 27 | ``` 28 | 29 | **Babel Configuration (.babelrc, package.json, cli command)** 30 | 31 | ```js 32 | { 33 | "your": { "config": "here" } 34 | } 35 | ``` 36 | 37 | **Expected behavior/code** 38 | A clear and concise description of what you expected to happen (or code). 39 | 40 | **Environment** 41 | - Babel version(s): [e.g. v6.0.0, v7.0.0-beta.34] 42 | - Node/npm version: [e.g. Node 8/npm 5] 43 | - OS: [e.g. OSX 10.13.4, Windows 10] 44 | - Monorepo [e.g. yes/no/Lerna] 45 | - How you are using Babel: [e.g. `cli`, `register`, `loader`] 46 | -------------------------------------------------------------------------------- /emoji-guide/Support_question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F917 Support Question" 3 | about: "If you have a question \U0001F4AC, please check out our Slack or StackOverflow!" 4 | title: '' 5 | labels: 'i: question, i: needs triage' 6 | assignees: '' 7 | 8 | --- 9 | 10 | --------------^ Click "Preview" for a nicer view! 11 | We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks! 😁. 12 | 13 | --- 14 | 15 | * Slack Community Chat: https://babeljs.slack.com (you can sign-up at https://slack.babeljs.io/ for an invite) 16 | * StackOverflow: https://stackoverflow.com/questions/tagged/babeljs using the tag `babeljs` 17 | * Twitter: If it's just a quick question you can ping our Twitter: https://twitter.com/babeljs 18 | * Also have a look at the readme for more information on how to get support: 19 | https://github.com/babel/babel/blob/master/README.md 20 | -------------------------------------------------------------------------------- /emoji-guide/Support_us.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F91D Support us on Babel" 3 | about: "If you would like to support our efforts in maintaining this community-driven 4 | project \U0001F64C!" 5 | title: '' 6 | labels: '' 7 | assignees: '' 8 | 9 | --- 10 | 11 | --------------^ Click "Preview" for a nicer view! 12 | > Open Collective: https://opencollective.com/babel 13 | > Henry's Patreon: https://www.patreon.com/henryzhu 14 | 15 | Help support Babel! 16 | 17 | Babel has always been a community project, not really backed or owned by any single (or group) of companies. While some maintainers used to work at Facebook (and Henry at Adobe) no one was working on it full time and there certainly isn't a huge company or team anywhere doing all this work. 18 | 19 | --- 20 | 21 | As a group of volunteers you can help us in a few ways 22 | 23 | - Giving developer time on the project. (Message us on [Twitter](https://twitter.com/babeljs) or [Slack](https://slack.babeljs.io/) for guidance). Companies should be paying their employees to contribute back to the open source projects they use everyday. 24 | - Giving funds by becoming one of our sponsors/donators! 25 | 26 | If you'd like to sustain the future of the project as a whole, we have an [Open Collective](https://opencollective.com/babel) that you can donate to. This is a way for funds to be allocated to the core team. 27 | 28 | You can also support [Henry](https://github.com/hzoo) directly since I [left my job to work on Babel and Open Source full time](https://twitter.com/left_pad/status/969793227862790144) at my [Patreon](https://www.patreon.com/henryzhu). 29 | -------------------------------------------------------------------------------- /must-open-issue-before-pr/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Hey there and thank you for using Issue Tracker! 2 | 3 | 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. 4 | 5 | Do the checklist before filing an issue: 6 | 7 | - [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome. 8 | - [ ] Have a usage question? Ask your question on [StackOverflow](http://stackoverflow.com). We use StackOverflow for usage question and GitHub for bugs. 9 | - [ ] 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. 10 | 11 | 12 | None of the above, create a bug report 13 | ------------------------------------------------------------------ 14 | 15 | 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. 16 | 17 | - [ ] Provide a **minimal code snippet** / [rnplay](https://rnplay.org/) example that reproduces the bug. 18 | - [ ] Provide **screenshots** where appropriate 19 | - [ ] What's the **version** of React Native you're using? 20 | - [ ] Does this occur on iOS, Android or both? 21 | - [ ] Are you using Mac, Linux or Windows? 22 | -------------------------------------------------------------------------------- /must-open-issue-before-pr/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | **IMPORTANT: Please do not create a Pull Request without creating an issue first.** 2 | 3 | *Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.* 4 | 5 | Please provide enough information so that others can review your pull request: 6 | 7 | <!-- You can skip this if you're fixing a typo or adding an app to the Showcase. --> 8 | 9 | Explain the **details** for making this change. What existing problem does the pull request solve? 10 | 11 | <!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. --> 12 | 13 | **Test plan (required)** 14 | 15 | Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. 16 | 17 | <!-- Make sure tests pass on both Travis and Circle CI. --> 18 | 19 | **Code formatting** 20 | 21 | <!-- See the simple style guide. --> 22 | 23 | **Closing issues** 24 | 25 | Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). 26 | -------------------------------------------------------------------------------- /no-duplicates/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Your issue may already be reported! 2 | Please search on the [issue tracker](../) before creating one. 3 | 4 | ## Expected Behavior 5 | <!--- If you're describing a bug, tell us what should happen --> 6 | <!--- If you're suggesting a change/improvement, tell us how it should work --> 7 | 8 | ## Current Behavior 9 | <!--- If describing a bug, tell us what happens instead of the expected behavior --> 10 | <!--- If suggesting a change/improvement, explain the difference from current behavior --> 11 | 12 | ## Possible Solution 13 | <!--- Not obligatory, but suggest a fix/reason for the bug, --> 14 | <!--- or ideas how to implement the addition or change --> 15 | 16 | ## Steps to Reproduce (for bugs) 17 | <!--- Provide a link to a live example, or an unambiguous set of steps to --> 18 | <!--- reproduce this bug. Include code to reproduce, if relevant --> 19 | 1. 20 | 2. 21 | 3. 22 | 4. 23 | 24 | ## Context 25 | <!--- How has this issue affected you? What are you trying to accomplish? --> 26 | <!--- Providing context helps us come up with a solution that is most useful in the real world --> 27 | 28 | ## Your Environment 29 | <!--- Include as many relevant details about the environment you experienced the bug in --> 30 | * Version used: 31 | * Browser Name and version: 32 | * Operating System and version (desktop or mobile): 33 | * Link to your project: 34 | -------------------------------------------------------------------------------- /no-duplicates/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | A similar PR may already be submitted! 2 | Please search among the [Pull request](../) before creating one. 3 | 4 | Thanks for submitting a pull request! Please provide enough information so that others can review your pull request: 5 | 6 | For more information, see the `CONTRIBUTING` guide. 7 | 8 | 9 | **Summary** 10 | 11 | <!-- Summary of the PR --> 12 | 13 | This PR fixes/implements the following **bugs/features** 14 | 15 | * [ ] Bug 1 16 | * [ ] Bug 2 17 | * [ ] Feature 1 18 | * [ ] Feature 2 19 | * [ ] Breaking changes 20 | 21 | <!-- You can skip this if you're fixing a typo or adding an app to the Showcase. --> 22 | 23 | Explain the **motivation** for making this change. What existing problem does the pull request solve? 24 | 25 | <!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. --> 26 | 27 | **Test plan (required)** 28 | 29 | Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. 30 | 31 | <!-- Make sure tests pass on both Travis and Circle CI. --> 32 | 33 | **Code formatting** 34 | 35 | <!-- See the simple style guide. --> 36 | 37 | **Closing issues** 38 | 39 | <!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). --> 40 | Fixes # 41 | -------------------------------------------------------------------------------- /questions-answers/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## *Who* is the bug affecting? 2 | <!-- Ex. All supervisors, Sally Supervisor, Level 1 CCs --> 3 | 4 | ## *What* is affected by this bug? 5 | <!-- Ex. supervision, sending messages, texter profiles --> 6 | 7 | ## *When* does this occur? 8 | <!-- Ex. After ending a conversation, every night at 3pm, when I sign off --> 9 | 10 | ## *Where* on the platform does it happen? 11 | <!-- Ex. In the a Supervisor chat box, on the conversation profile page, on the two-factor screen --> 12 | 13 | 14 | ## *How* do we replicate the issue? 15 | <!-- Please be specific as possible. Use dashes (-) or numbers (1.) to create a list of steps --> 16 | 17 | 18 | ## Expected behavior (i.e. solution) 19 | <!-- What should have happened? --> 20 | 21 | 22 | ## Other Comments 23 | -------------------------------------------------------------------------------- /questions-answers/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | <!--- Provide a general summary of your changes in the Title above --> 2 | 3 | ## Description 4 | <!--- Describe your changes in detail --> 5 | 6 | ## Motivation and Context 7 | <!--- Why is this change required? What problem does it solve? --> 8 | <!--- If it fixes an open issue, please link to the issue here. --> 9 | 10 | ## How has this been tested? 11 | <!--- Please describe in detail how you tested your changes. --> 12 | <!--- Include details of your testing environment, tests ran to see how --> 13 | <!--- your change affects other areas of the code, etc. --> 14 | 15 | ## Screenshots (if appropriate): 16 | 17 | ## Types of changes 18 | <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> 19 | - [ ] Bug fix (non-breaking change which fixes an issue) 20 | - [ ] New feature (non-breaking change which adds functionality) 21 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 22 | 23 | ## Checklist: 24 | <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> 25 | <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> 26 | - [ ] My code follows the code style of this project. 27 | - [ ] My change requires a change to the documentation. 28 | - [ ] I have updated the documentation accordingly. 29 | - [ ] I have added tests to cover my changes. 30 | - [ ] All new and existing tests passed. 31 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | ## A collection of GitHub issue and pull request templates 2 | 3 | *Update*: GitHub now also supports [multiple issue templates](https://help.github.com/articles/about-issue-and-pull-request-templates/). 4 | 5 | ~~GitHub finally supports [issue template](https://github.com/blog/2111-issue-and-pull-request-templates).~~ 6 | 7 | # What is an issue template? 8 | 9 | [Issue and Pull Request templates](https://blog.github.com/2016-02-17-issue-and-pull-request-templates/) 10 | 11 | # How to create issue templates? 12 | 13 | - [About issue and pull request templates](https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates) 14 | - ~~[Manually creating a single issue template for your repository](https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/)~~ 15 | 16 | # 10+ templates for you to pick! 17 | 18 | Find your issue/PR templates, and just grab and go. 19 | 20 | *Inspired by excellent GitHub projects that use issue and pull request templates.* 21 | 22 | Templates here are either copied from or modified based on real projects on GitHub. 23 | 24 | *See also [awesome-github-templates](https://github.com/devspace/awesome-github-templates) for more examples in real projects :tada:* 25 | 26 | # Contribution 27 | 28 | If you want to contribute to this project, send a PR directly instead of creating an issue. 29 | 30 | ## License 31 | 32 | [![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/) 33 | 34 | To the extent possible under law, [Steve Mao](https://github.com/stevemao) has waived all copyright and related or neighboring rights to this work. 35 | -------------------------------------------------------------------------------- /screenshots/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Issue and Steps to Reproduce 2 | <!-- Describe your issue and tell us how to reproduce it (include any useful information). --> 3 | 4 | ### Versions 5 | 6 | ### Screenshots 7 | 8 | #### Expected 9 | 10 | #### Actual 11 | 12 | ### Additional Details 13 | * Installed packages: 14 | -------------------------------------------------------------------------------- /screenshots/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## A picture tells a thousand words 2 | 3 | ## Before this PR 4 | 5 | ## After this PR 6 | -------------------------------------------------------------------------------- /simple/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Expected Behavior 2 | 3 | 4 | ## Actual Behavior 5 | 6 | 7 | ## Steps to Reproduce the Problem 8 | 9 | 1. 10 | 1. 11 | 1. 12 | 13 | ## Specifications 14 | 15 | - Version: 16 | - Platform: 17 | - Subsystem: 18 | -------------------------------------------------------------------------------- /simple/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Fixes # 2 | 3 | ## Proposed Changes 4 | 5 | - 6 | - 7 | - 8 | -------------------------------------------------------------------------------- /squash-commits/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | <!-- 2 | Issue template 3 | To Use this Template: 4 | * Fill out what you can 5 | * Delete what you do not fill out 6 | --> 7 | 8 | NOTE: ISSUES ARE NOT FOR CODE HELP - Ask for Help at https://stackoverflow.com 9 | 10 | #### Issue Description 11 | * When Issue Happens 12 | * Steps To Reproduce 13 | 14 | #### Browser Information 15 | * Browser Name, Version 16 | * Operating System 17 | 18 | #### Your Code 19 | 20 | ``` 21 | If relevant, paste all of your challenge code in here 22 | ``` 23 | 24 | #### Screenshot 25 | -------------------------------------------------------------------------------- /squash-commits/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Pull Request template 2 | Please, go through these steps before you submit a PR. 3 | 4 | 1. Make sure that your PR is not a duplicate. 5 | 2. If not, then make sure that: 6 | 7 | a. 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`. 8 | 9 | b. You have a descriptive commit message with a short title (first line). 10 | 11 | c. You have only one commit (if not, squash them into one commit). 12 | 13 | d. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`). 14 | 15 | 3. **After** these steps, you're ready to open a pull request. 16 | 17 | a. Your pull request MUST NOT target the `master` branch on this repository. You probably want to target `staging` instead. 18 | 19 | b. Give a descriptive title to your PR. 20 | 21 | c. Provide a description of your changes. 22 | 23 | d. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). 24 | 25 | IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines. 26 | 27 | **PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING** 28 | -------------------------------------------------------------------------------- /system/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | <!-- 2 | Thank you for reporting an issue. 3 | 4 | This issue tracker is for bugs and issues found within Node.js core. 5 | If you require more general support please file an issue on our help 6 | repo. https://github.com/nodejs/help 7 | 8 | 9 | Please fill in as much of the template below as you're able. 10 | 11 | Version: output of `node -v` 12 | Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) 13 | Subsystem: if known, please specify affected core module name 14 | 15 | If possible, please provide code that demonstrates the problem, keeping it as 16 | simple and free of external dependencies as you are able. 17 | --> 18 | 19 | * **Version**: <!-- compulsory. you must provide your version --> 20 | * **Platform**: <!-- either `uname -a` output, or if Windows, version and 32-bit or 21 | 64-bit --> 22 | * **Subsystem**: <!-- optional. if known - please specify affected core module name --> 23 | 24 | <!-- Enter your issue details below this comment. --> 25 | -------------------------------------------------------------------------------- /system/ISSUE_TEMPLATE/1-bug-report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F41B Bug report" 3 | about: Create a report to help us improve 4 | 5 | --- 6 | 7 | <!-- 8 | Thank you for reporting a possible bug in Node.js. 9 | 10 | Please fill in as much of the template below as you can. 11 | 12 | Version: output of `node -v` 13 | Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) 14 | Subsystem: if known, please specify the affected core module name 15 | 16 | If possible, please provide code that demonstrates the problem, keeping it as 17 | simple and free of external dependencies as you can. 18 | --> 19 | 20 | * **Version**: 21 | * **Platform**: 22 | * **Subsystem**: 23 | 24 | <!-- Please provide more details below this comment. --> 25 | -------------------------------------------------------------------------------- /system/ISSUE_TEMPLATE/2-feature-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F680 Feature request" 3 | about: Suggest an idea for this project 4 | 5 | --- 6 | 7 | <!-- 8 | Thank you for suggesting an idea to make Node.js better. 9 | 10 | Please fill in as much of the template below as you're able. 11 | --> 12 | 13 | **Is your feature request related to a problem? Please describe.** 14 | Please describe the problem you are trying to solve. 15 | 16 | **Describe the solution you'd like** 17 | Please describe the desired behavior. 18 | 19 | **Describe alternatives you've considered** 20 | Please describe alternative solutions or features you have considered. 21 | -------------------------------------------------------------------------------- /system/ISSUE_TEMPLATE/3-help.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "⁉️ Need help with Node.js?" 3 | about: Please file an issue in our help repo. 4 | 5 | --- 6 | 7 | If you have a question about Node.js that is not a bug report or feature 8 | request, please post it in https://github.com/nodejs/help! 9 | 10 | Questions posted to this repository will be closed. 11 | -------------------------------------------------------------------------------- /system/ISSUE_TEMPLATE/4-nodejs-org.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F310 Found a problem with nodejs.org?" 3 | about: Please file an issue in the Node.js website repo. 4 | 5 | --- 6 | 7 | If you have a question, suggestion or issue regarding our website, 8 | please post it in https://github.com/nodejs/nodejs.org! 9 | 10 | Issues with the Node.js API documentation should be posted here. All other 11 | issues regarding the website will be closed. 12 | -------------------------------------------------------------------------------- /system/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | <!-- 2 | Thank you for your pull request. Please provide a description above and review 3 | the requirements below. 4 | 5 | Bug fixes and new features should include tests and possibly benchmarks. 6 | 7 | Contributors guide: ./CONTRIBUTING.md 8 | --> 9 | 10 | <!-- _Please make sure to review and check all of these items:_ --> 11 | 12 | 13 | ##### Checklist 14 | <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> 15 | 16 | - [ ] `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes 17 | - [ ] tests and/or benchmarks are included 18 | - [ ] documentation is changed or added 19 | - [ ] commit message follows [commit guidelines](./doc/guides/contributing/pull-requests.md#commit-message-guidelines) 20 | 21 | <!-- _NOTE: these things are not required to open a PR and can be done afterwards / while the PR is open._ --> 22 | 23 | ### Affected core subsystem(s) 24 | <!-- Please provide affected core subsystem(s). --> 25 | 26 | ### Description of change 27 | <!-- Please provide a description of the change here. --> 28 | --------------------------------------------------------------------------------