Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updates to issue template and gh actions #781

Merged
merged 1 commit into from
Feb 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: "\U0001F41B Bug Report"
description: 'Report a bug'
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a bug report! Please fill out this entire form.
- type: checkboxes
attributes:
label: I have searched open and closed issues for this issue.
options:
- label: I have searched open and closed issues.
required: true

- type: input
attributes:
label: Minimal reproducible example
description: |
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.

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.

If a reproducible example is not provided, your issue is likely to be closed.
[Learn more about creating a minimal reproducible example](https://stackoverflow.com/help/mcve).
validations:
required: true
- type: dropdown
attributes:
label: What platform(s) does this occur on?
multiple: true
options:
- Android
- iOS
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
Explain the steps we need to take to reproduce the issue. Include a video or screenshots if you think it may help.
Clearly describe what the expected behavior is and what instead is actually happening. Be concise and precise in your description.
validations:
required: true
- type: textarea
attributes:
render: text
label: Your computer environment
description: Run the `npx react-native info` command and paste its output in the field below.
validations:
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "Feature request template"
description: 'Request a feature'
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a feature request! Please fill out this form.
- type: textarea
attributes:
label: Feature description
description: |
Please describe what feature you think is missing and link to the documentation of the underlying Google's SDKs which covers the functionality.

Thank you!
validations:
required: true
- type: dropdown
attributes:
label: What platform(s) should this be implemented on?
multiple: true
options:
- Android
- iOS
- web
validations:
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: "Question template"
description: 'Ask a question'
labels: ['question']
body:
- type: markdown
attributes:
value: Please use the [GH discussions](https://github.com/react-native-google-signin/google-signin/discussions) for questions. Thank you!
- type: dropdown
attributes:
label: I will post my question to GH discussions.
options:
- 'Yes'
validations:
required: true
36 changes: 0 additions & 36 deletions .github/label-actions.yml

This file was deleted.

21 changes: 0 additions & 21 deletions .github/workflows/label-actions.yml

This file was deleted.

30 changes: 30 additions & 0 deletions .github/workflows/support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 'Support requests'

on:
issues:
types: [labeled, unlabeled, reopened]

jobs:
support:
runs-on: ubuntu-latest
steps:
- uses: dessant/support-requests@v4
with:
github-token: ${{ github.token }}
support-label: 'repro-required'
issue-comment: >
: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)).

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.

Please create a new issue with this and the maintainer will do his best to review it!.
close-issue: true
lock-issue: true
- uses: dessant/support-requests@v4
with:
github-token: ${{ github.token }}
support-label: 'question'
issue-comment: >
:wave: @{issue-author}, please post your question to [discussions](https://github.com/react-native-documents/document-picker/discussions) instead.
close-issue: true
lock-issue: true
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# react-native-documents

A set of React Native modules for document picking and viewing.
React Native modules for document picking and viewing.

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

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

Ask questions and engage in discussions at https://github.com/react-native-documents/document-picker/discussions
6 changes: 3 additions & 3 deletions docs/docs/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ yarn add @react-native-documents/viewer

## Setting up

The packages are designed to support last 3 stable versions of RN. However, they very likely work with RN 0.73 and up.

:::warning
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`.

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

:::info

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.
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.

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.

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

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

The packages support last 3 stable releases of RN, but very likely work with RN 0.73 and up.

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.
2 changes: 1 addition & 1 deletion docs/src/pages/github-repo.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### Github Repository

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