From 653a119b91ee2af65941178b290355cfb04d3dd1 Mon Sep 17 00:00:00 2001 From: Satyajit Sahoo Date: Sat, 11 Jan 2020 16:28:07 +0100 Subject: [PATCH] chore: update issue template --- .../.github/ISSUE_TEMPLATE.md | 39 ------------------- .../.github/ISSUE_TEMPLATE/bug_report.md | 36 +++++++++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 38 ++++++++++++++++++ .../.github/PULL_REQUEST_TEMPLATE.md | 8 ++-- 4 files changed, 78 insertions(+), 43 deletions(-) delete mode 100644 packages/react-navigation/.github/ISSUE_TEMPLATE.md create mode 100644 packages/react-navigation/.github/ISSUE_TEMPLATE/bug_report.md create mode 100644 packages/react-navigation/.github/ISSUE_TEMPLATE/config.yml diff --git a/packages/react-navigation/.github/ISSUE_TEMPLATE.md b/packages/react-navigation/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 0464ca3e..00000000 --- a/packages/react-navigation/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,39 +0,0 @@ -## The issue tracker is reserved for bug reports only. - -If you have a question, feature request, or an idea for improving the library or its related tools, please try one of the following resources: - -- [Read the documentation](https://reactnavigation.org/) -- [Post an issue to the website repository if you'd like to see a documentation change](http://github.com/react-navigation/website) -- [Post a feature request to Canny](https://react-navigation.canny.io/feature-requests) -- [Write a RFC if you have ideas for how to implement a feature request](https://github.com/react-navigation/rfcs) -- [Get help on Discord chat (#react-navigation on Reactiflux)](https://discord.gg/4xEK3nD) or [on StackOverflow](https://stackoverflow.com/questions/tagged/react-navigation) -- Search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue. - -Bugs with react-navigation must be reproducible *without any external libraries that operate on it*. This means that if you are attempting to use Redux or MobX with it and you think you have found a bug, you must be able to reproduce it without Redux or MobX in this report. Redux related issues belong in [react-navigation-redux-helpers](https://github.com/react-navigation/react-navigation-redux-helpers), and we do not have any first-class integration with MobX at the moment. - ---- - -### Current Behavior - -- What code are you running and what is happening? -- Include a screenshot if it makes sense. - -### Expected Behavior - -- What do you expect should be happening? -- Include a screenshot if it makes sense. - -### How to reproduce - -- You must provide a way to reproduce the problem. If you are having an issue with your machine or build tools, the issue belongs on another repository as that is outside of the scope of React Navigation. -- Either re-create the bug on [Snack](https://snack.expo.io) or link to a GitHub repository with code that reproduces the bug. -- Explain how to run the example app and any steps that we need to take to reproduce the issue from the example app. - -### Your Environment - -| software | version -| ---------------- | ------- -| react-navigation | -| react-native | -| node | -| npm or yarn | diff --git a/packages/react-navigation/.github/ISSUE_TEMPLATE/bug_report.md b/packages/react-navigation/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..078c153a --- /dev/null +++ b/packages/react-navigation/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,36 @@ +--- +name: Miscellaneous +about: Report an issue which is regarding the core API of React Navigation. +title: '' +labels: bug +assignees: '' +--- + +**Current Behavior** + +- What code are you running and what is happening? +- Include a screenshot or video if it makes sense. + +**Expected Behavior** + +- What do you expect should be happening? +- Include a screenshot or video if it makes sense. + +**How to reproduce** + +- You must provide a way to reproduce the problem. If you are having an issue with your machine or build tools, the issue belongs on another repository as that is outside of the scope of React Navigation. +- Either re-create the bug on [Snack](https://snack.expo.io) or link to a GitHub repository with code that reproduces the bug. +- Explain how to run the example app and any steps that we need to take to reproduce the issue from the example app. +- Keep the repro code as simple as possible, with the minimum amount of code required to repro the issue. +- Before reporting an issue, make sure you are on latest version of the package. + +**Your Environment** + +| software | version | +| ---------------- | ------- | +| iOS or Android | +| react-navigation | +| react-native | +| expo | +| node | +| npm or yarn | diff --git a/packages/react-navigation/.github/ISSUE_TEMPLATE/config.yml b/packages/react-navigation/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..e8bfa7f2 --- /dev/null +++ b/packages/react-navigation/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,38 @@ +blank_issues_enabled: false +contact_links: + - name: Stack Navigator + url: https://github.com/react-navigation/stack/issues/new + about: Submit a bug report for Stack Navigator (react-navigation-stack). + - name: Drawer Navigator + url: https://github.com/react-navigation/drawer/issues/new + about: Submit a bug report for Drawer Navigator (react-navigation-drawer). + - name: Tab Navigator + url: https://github.com/react-navigation/tabs/issues/new + about: Submit a bug report for Bottom Tab Navigator and Material Top Tab Navigator (react-navigation-tabs). + - name: Material Bottom Tab Navigator + url: https://github.com/react-navigation/material-bottom-tabs/issues/new + about: Submit a bug report for Material Bottom Tab Navigator (react-navigation-material-bottom-tabs). + - name: Animated Switch Navigator + url: https://github.com/react-navigation/animated-switch/issues/new + about: Submit a bug report for Animated Switch Navigator (react-navigation-animated-switch). + - name: React Navigation 5 + url: https://github.com/react-navigation/navigation-ex/issues/new/choose + about: Submit a bug report for React Navigation 5. + - name: Common mistakes + url: https://reactnavigation.org/docs/en/common-mistakes.html + about: Read about common mistakes and how to fix them. + - name: Documentation + url: https://reactnavigation.org + about: Read the official documentation. + - name: Feature requests + url: https://react-navigation.canny.io/feature-requests + about: Post a feature request on Canny. + - name: StackOverflow + url: https://stackoverflow.com/questions/tagged/react-navigation + about: Ask and answer questions using the react-navigation label. + - name: Reactiflux + url: https://www.reactiflux.com/ + about: Chat with other community members in the react-navigation channel. + - name: Write an RFC + url: https://github.com/react-navigation/rfcs + about: Write a RFC if you have ideas for how to implement a feature request. diff --git a/packages/react-navigation/.github/PULL_REQUEST_TEMPLATE.md b/packages/react-navigation/.github/PULL_REQUEST_TEMPLATE.md index db607a07..74790f74 100644 --- a/packages/react-navigation/.github/PULL_REQUEST_TEMPLATE.md +++ b/packages/react-navigation/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,10 @@ Please provide enough information so that others can review your pull request: -## Motivation +**Motivation** Explain the **motivation** for making this change. What existing problem does the pull request solve? -## Test plan +**Test plan** Demonstrate the code is solid. Example: the exact commands you ran and their output, screenshots / videos if the pull request changes UI. @@ -12,6 +12,6 @@ Make sure you test on both platforms if your change affects both platforms. The code must pass tests. -## Code formatting +**Code formatting** -Look around. Match the style of the rest of the codebase. Run `yarn format` before committing. +Look around. Match the style of the rest of the codebase. Run `yarn lint --fix` before committing.