Skip to content

Commit 89ac9c6

Browse files
authored
chore: updates to issue template and gh actions (#781)
1 parent 62794a6 commit 89ac9c6

File tree

9 files changed

+127
-64
lines changed

9 files changed

+127
-64
lines changed

.github/ISSUE_TEMPLATE/custom.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "\U0001F41B Bug Report"
2+
description: 'Report a bug'
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: Thanks for taking the time to file a bug report! Please fill out this entire form.
7+
- type: checkboxes
8+
attributes:
9+
label: I have searched open and closed issues for this issue.
10+
options:
11+
- label: I have searched open and closed issues.
12+
required: true
13+
14+
- type: input
15+
attributes:
16+
label: Minimal reproducible example
17+
description: |
18+
A link to a GitHub repository containing a minimal reproducible example. This repository should include as little code as possible and not include extraneous dependencies.
19+
20+
Try to reproduce the bugs on the provided example app. Either provide a link to the repo that reproduces the bug or provide your version of the `App.tsx` file that reproduces the issue and that we can easily use.
21+
22+
If a reproducible example is not provided, your issue is likely to be closed.
23+
[Learn more about creating a minimal reproducible example](https://stackoverflow.com/help/mcve).
24+
validations:
25+
required: true
26+
- type: dropdown
27+
attributes:
28+
label: What platform(s) does this occur on?
29+
multiple: true
30+
options:
31+
- Android
32+
- iOS
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Steps to reproduce
38+
description: |
39+
Explain the steps we need to take to reproduce the issue. Include a video or screenshots if you think it may help.
40+
Clearly describe what the expected behavior is and what instead is actually happening. Be concise and precise in your description.
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
render: text
46+
label: Your computer environment
47+
description: Run the `npx react-native info` command and paste its output in the field below.
48+
validations:
49+
required: true
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: "Feature request template"
2+
description: 'Request a feature'
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: Thanks for taking the time to file a feature request! Please fill out this form.
7+
- type: textarea
8+
attributes:
9+
label: Feature description
10+
description: |
11+
Please describe what feature you think is missing and link to the documentation of the underlying Google's SDKs which covers the functionality.
12+
13+
Thank you!
14+
validations:
15+
required: true
16+
- type: dropdown
17+
attributes:
18+
label: What platform(s) should this be implemented on?
19+
multiple: true
20+
options:
21+
- Android
22+
- iOS
23+
- web
24+
validations:
25+
required: true

.github/ISSUE_TEMPLATE/question.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Question template"
2+
description: 'Ask a question'
3+
labels: ['question']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Please use the [GH discussions](https://github.com/react-native-google-signin/google-signin/discussions) for questions. Thank you!
8+
- type: dropdown
9+
attributes:
10+
label: I will post my question to GH discussions.
11+
options:
12+
- 'Yes'
13+
validations:
14+
required: true

.github/label-actions.yml

Lines changed: 0 additions & 36 deletions
This file was deleted.

.github/workflows/label-actions.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/workflows/support.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 'Support requests'
2+
3+
on:
4+
issues:
5+
types: [labeled, unlabeled, reopened]
6+
7+
jobs:
8+
support:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: dessant/support-requests@v4
12+
with:
13+
github-token: ${{ github.token }}
14+
support-label: 'repro-required'
15+
issue-comment: >
16+
:wave: @{issue-author}, sorry you're having an issue. As the issue template explains, it's required that you provide a runnable example that reproduces your issue (see the [issue template](../ISSUE_TEMPLATE/custom.yaml)).
17+
18+
The reason is that a bug report is not actionable without a reproducer. Try to minimize the superfluous code and focus only on reproducing the bug.
19+
20+
Please create a new issue with this and the maintainer will do his best to review it!.
21+
close-issue: true
22+
lock-issue: true
23+
- uses: dessant/support-requests@v4
24+
with:
25+
github-token: ${{ github.token }}
26+
support-label: 'question'
27+
issue-comment: >
28+
:wave: @{issue-author}, please post your question to [discussions](https://github.com/react-native-documents/document-picker/discussions) instead.
29+
close-issue: true
30+
lock-issue: true

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# react-native-documents
22

3-
A set of React Native modules for document picking and viewing.
3+
React Native modules for document picking and viewing.
44

5-
Read the docs at https://react-native-documents.github.io/
5+
If this is useful to you, [say thanks](https://github.com/sponsors/vonovak). Your support is greatly appreciated!
66

7-
If this is useful to you, consider [saying thanks](https://github.com/sponsors/vonovak). Your support is greatly appreciated!!!
7+
Read the docs at https://react-native-documents.github.io
8+
9+
Ask questions and engage in discussions at https://github.com/react-native-documents/document-picker/discussions

docs/docs/install.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ yarn add @react-native-documents/viewer
1717

1818
## Setting up
1919

20+
The packages are designed to support last 3 stable versions of RN. However, they very likely work with RN 0.73 and up.
21+
2022
:::warning
2123
The document picker package requires iOS 14 or later. If you use Expo, use Expo SDK >=52 or [Expo build properties](https://docs.expo.dev/versions/latest/sdk/build-properties/#example-appjson-with-config-plugin) to update the `deploymentTarget` to `14`.
2224

@@ -27,7 +29,7 @@ In regular React Native projects, use RN >= 0.76 or update the [settings in Xcod
2729

2830
:::info
2931

30-
These packages cannot be used in ["Expo Go"](https://docs.expo.dev/workflow/overview/#expo-go-an-optional-tool-for-learning) because they require custom native code.
32+
These packages cannot be used in ["Expo Go"](https://docs.expo.dev/workflow/overview/#expo-go-an-optional-tool-for-learning) because they include custom native code.
3133

3234
However, you can add custom native code to an Expo app through a [development build](https://docs.expo.dev/workflow/overview/#development-builds). That is the officially recommended approach for building Expo apps. See the commands below to do this.
3335

@@ -46,6 +48,4 @@ expo run:android
4648

4749
Install the package and then run `pod install` from the ios directory. Then rebuild your project with Xcode.
4850

49-
The packages support last 3 stable releases of RN, but very likely work with RN 0.73 and up.
50-
5151
If you're using the [New Architecture](https://reactnative.dev/docs/new-architecture-intro), it's strongly recommended to use the latest stable release of RN.

docs/src/pages/github-repo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
### Github Repository
22

3-
The monorepo with sources for the document picker and viewer modules is accessible to sponsors at https://github.com/react-native-documents/document-picker
3+
The monorepo with sources for the document picker and viewer modules is accessible at https://github.com/react-native-documents/document-picker

0 commit comments

Comments
 (0)