chore: update issue template (#1552)

* chore: update issue template * Update screens version in issue template
software-mansion · Aug 11, 2022 · e541f9a · e541f9a
1 parent e8262b0
commit e541f9a
Show file tree

Hide file tree

Showing 6 changed files with 181 additions and 141 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,156 @@
+name: Bug report
+description: Report an issue with Screens here.
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+        Before you proceed:
+
+        - Make sure to check whether there are similar issues in the repository
+        - Make sure to clean cache in your project. Depending on your setup this could be done by:
+          - `yarn start --reset-cache` or
+          - `npm start -- --reset-cache` or
+          - `expo start --clear`
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Required information
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please provide a clear, concise and descriptive explaination of what the bug is. Include screenshots or a video if needed. Tell us what were you expecting to happen instead of what is happening now.
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Provide a detailed list of steps that reproduce the issue.
+      placeholder: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: input
+    id: repro
+    attributes:
+      label: Snack or a link to a repository
+      description: |
+        Please provide a Snack (https://snack.expo.io/) or a link to a repository on GitHub under your username that reproduces the issue.
+        Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
+        Issues without a reproduction are likely to stale.
+      placeholder: Link to a Snack or a GitHub repository
+    validations:
+      required: true
+
+  - type: input
+    id: screens-version
+    attributes:
+      label: Screens version
+      description: What version of react-native-screens are you using?
+      placeholder: 3.15.0
+    validations:
+      required: true
+
+  - type: input
+    id: react-native-version
+    attributes:
+      label: React Native version
+      description: What version of react-native are you using?
+      placeholder: 0.69.0
+    validations:
+      required: true
+
+  - type: dropdown
+    id: platforms
+    attributes:
+      label: Platforms
+      description: On what platform your application is running on?
+      multiple: true
+      options:
+        - Android
+        - iOS
+        - Web
+        - Windows
+        - tvOS
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Additonal information
+
+        Providing as much information as possible greatly helps us with reproducting the issues.
+
+  - type: dropdown
+    id: runtime
+    attributes:
+      label: JavaScript runtime
+      description: What runtime is your application using?
+      options:
+        - JSC
+        - Hermes
+        - V8
+
+  - type: dropdown
+    id: workflow
+    attributes:
+      label: Workflow
+      description: How your application is managed? Not sure? Read [this part](https://docs.expo.dev/introduction/managed-vs-bare/) of Expo documentation
+      options:
+        - React Native (without Expo)
+        - Expo bare workflow
+        - Expo managed workflow
+
+  - type: dropdown
+    id: architecture
+    attributes:
+      label: Architecture
+      description: What React Native architecture your application is running on? Currently, the default architecture on React Native is Paper so if you haven't changed it in your application select this option.
+      options:
+        - Paper (Old Architecture)
+        - Fabric (New Architecture)
+
+  - type: dropdown
+    id: build-type
+    attributes:
+      label: Build type
+      description: What mode your application is running?
+      options:
+        - Debug mode
+        - Release mode
+
+  - type: dropdown
+    id: emulator
+    attributes:
+      label: Device
+      description: How are you running your application?
+      options:
+        - iOS simulator
+        - Android emulator
+        - Real device
+
+  - type: input
+    id: device-model
+    attributes:
+      label: Device model
+      description: What device you are experiencing this problem on? Specify full device name along with the version of the operating system it's running.
+      placeholder: ex. Samsung Galaxy A22 (Android 12)
+
+  - type: dropdown
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: I searched for similar issues in the repository.
+      options:
+        - 'Yes'
+    validations:
+      required: true
diff --git a/.github/workflows/close-when-stale.yml b/.github/workflows/close-when-stale.yml
@@ -18,23 +18,16 @@ jobs:
           repository: 'software-mansion-labs/swmansion-bot'
           ref: stable
 
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Use yarn cache
-        uses: actions/cache@v2
-        id: yarn-cache
+      - uses: actions/cache@v2
         with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+
       - name: Install Actions
         run: yarn install
 
       - name: Close when stale
         uses: ./close-when-stale
         with:
-          close-when-stale-label: close-when-stale
+          close-when-stale-label: 'Close when stale'
           days-to-close: 20
diff --git a/.github/workflows/needs-more-info.yml b/.github/workflows/needs-more-info.yml
@@ -7,7 +7,7 @@ jobs:
   main:
     runs-on: ubuntu-latest
     concurrency:
-      group: needs-more-info-${{ github.ref }}
+      group: needs-more-info-${{ github.event.issue.number }}
       cancel-in-progress: true
     steps:
       - name: Checkout Actions
@@ -16,18 +16,10 @@ jobs:
           repository: 'software-mansion-labs/swmansion-bot'
           ref: stable
 
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Use yarn cache
-        uses: actions/cache@v2
-        id: yarn-cache
+      - uses: actions/cache@v2
         with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
       - name: Install Actions
         run: yarn install
@@ -36,8 +28,8 @@ jobs:
         uses: ./needs-more-info
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          needs-more-info-label: needs-more-info
-          required-sections: 'Description;Steps To Reproduce;Reproduction;Platform'
+          needs-more-info-label: 'Missing info'
+          required-sections: 'Description;Steps to reproduce;Snack or a link to a repository;Screens version;React Native version;Platforms'
           needs-more-info-response: "Hey! 👋 \n\nIt looks like you've omitted a few important sections from the issue template."
           # This action also appends something like: "Please complete X, Y and Z sections." to the response.
           # Code responsible for this can be found here: https://github.com/software-mansion-labs/swmansion-bot/blob/main/needs-more-info/MissingSectionsFormatter.js
diff --git a/.github/workflows/needs-repro.yml b/.github/workflows/needs-repro.yml
@@ -9,7 +9,7 @@ jobs:
   main:
     runs-on: ubuntu-latest
     concurrency:
-      group: needs-repro-${{ github.ref }}
+      group: needs-repro-${{ github.event.issue.number }}
       cancel-in-progress: true
     steps:
       - name: Checkout Actions
@@ -18,18 +18,10 @@ jobs:
           repository: 'software-mansion-labs/swmansion-bot'
           ref: stable
 
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Use yarn cache
-        uses: actions/cache@v2
-        id: yarn-cache
+      - uses: actions/cache@v2
         with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
       - name: Install Actions
         run: yarn install
@@ -38,7 +30,7 @@ jobs:
         uses: ./needs-repro
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          needs-repro-label: 🧰needs-repro
-          needs-repro-response: "Hey! 👋 \n\nThe issue doesn't seem to contain a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example).\n\nCould you provide a snippet of code, a [snack](https://snack.expo.dev/) or a link to a GitHub repository that reproduces the problem?"
-          repro-provided-label: repro-provided
+          needs-repro-label: 'Missing repro'
+          needs-repro-response: "Hey! 👋 \n\nThe issue doesn't seem to contain a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example).\n\nCould you provide a [snack](https://snack.expo.dev/) or a link to a GitHub repository under your username that reproduces the problem?"
+          repro-provided-label: 'Repro provided'
           check-issues-only-created-after: 2022-01-01
diff --git a/.github/workflows/platforms.yml b/.github/workflows/platforms.yml
@@ -7,7 +7,7 @@ jobs:
   main:
     runs-on: ubuntu-latest
     concurrency:
-      group: platforms-${{ github.ref }}
+      group: platforms-${{ github.event.issue.number }}
       cancel-in-progress: true
     steps:
       - name: Checkout Actions
@@ -16,18 +16,10 @@ jobs:
           repository: 'software-mansion-labs/swmansion-bot'
           ref: stable
 
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Use yarn cache
-        uses: actions/cache@v2
-        id: yarn-cache
+      - uses: actions/cache@v2
         with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
       - name: Install Actions
         run: yarn install
@@ -36,4 +28,6 @@ jobs:
         uses: ./platforms
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          platforms-with-labels: '{"Android": "🤖android", "iOS": "🍎iOS", "Web": "🧭web", "Windows": "🪟windows", "tvOS": "📺tvOS"}'
+          platforms-section-header: Platforms
+          platforms-comma-separated: true
+          platforms-with-labels: '{"Android": "Platform: Android", "iOS": "Platform: iOS", "Web": "Platform: Web", "Windows": "Platform: Windows", "tvOS": "Platform: tvOS"}'