Skip to content

Commit c90ef64

Browse files
committed
docs: readme and templates updates
1 parent 2f87a7c commit c90ef64

File tree

6 files changed

+21
-14
lines changed

6 files changed

+21
-14
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Bug report
2+
name: 🐛 Report a bug
33
about: Create a report to help us improve
44
title: ''
55
labels: 'bug'

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Feature request
2+
name: 🗣 Feature request
33
about: Suggest an idea for this project
44
title: ''
55
labels: 'feature request'

Diff for: .github/ISSUE_TEMPLATE/question.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
name: Question
3-
about: Ask question
2+
name: 💬 Question
3+
about: You need help with React Native Paper.
44
title: ''
55
labels: 'question'
66
assignees: ''
77

88
---
99

10-
10+
### Ask your Question
11+
<!-- A clear and concise question describing the concern -->

Diff for: .github/PULL_REQUEST.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@
33

44
### Motivation
55

6-
<!-- What existing problem does the pull request solve? Can you solve the issue with a different approach? -->
6+
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
7+
8+
### Related issue
9+
10+
<!-- If this pull request addresses an existing issue, link to the issue. If an issue is not present, describe the issue here. -->
711

812
### Test plan
913

10-
<!-- List the steps with which we can test this change. Provide screenshots if this changes anything visual. -->
14+
<!-- Describe the **steps to test this change**, so that a reviewer can verify it. Provide screenshots or videos if the change affects UI. -->
15+
16+
<!-- Keep in mind that PR changes must pass lint, typescript and tests. -->

Diff for: CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The core team works directly on GitHub and all work is public.
1313
> **Working on your first pull request?** You can learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
1414
1515
1. Fork the repo and create your branch from `main` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
16-
2. Run `yarn` to setup the development environment.
16+
2. Run `yarn bootstrap` on the root level, to setup the development environment.
1717
3. Do the changes you want and test them out in the example app before sending a pull request.
1818

1919
### Commit message convention

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@
1818
[![Chat][chat-badge]][chat]
1919
[![Sponsored by Callstack][callstack-badge]][callstack]
2020

21+
<p align="center"><i>React Native Paper is the cross-platform UI kit library containing a collection of customizable and production-ready components, which by default are following and respecting the Google’s Material Design guidelines.</i></p>
22+
2123
## Features
2224

23-
- Follows [material design guidelines](https://material.io/guidelines/)
25+
- Follows [material design guidelines](https://m3.material.io/get-started/)
2426
- Works on both iOS and Android following [platform adaptation guidelines](https://material.io/design/platform-guidance/cross-platform-adaptation.html)
2527
- Full [theming support](https://callstack.github.io/react-native-paper/theming.html)
2628

27-
Currently supported React Native version: `>= 0.50.3`
28-
2929
## Try it out
3030

31-
Run the [example app](https://snack.expo.dev/@react-native-paper/react-native-paper-example_v5) with [Expo](https://expo.dev/) to see it in action.
31+
🧑‍💻 Run the [example app](https://snack.expo.dev/@react-native-paper/react-native-paper-example_v5) with [Expo](https://expo.dev/) to see it in action. The source code for the examples are under the [/example](/example) folder.
3232

33-
The source code for the examples are under the [/example](/example) folder.
33+
📲 You can also try out components in our demo apps available in the both stores [Android](https://play.google.com/store/apps/details?id=com.callstack.reactnativepaperexample&hl=pl&gl=US) and [ iOS](https://apps.apple.com/app/react-native-paper/id1548934513).
3434

3535
## Getting Started
3636

@@ -46,7 +46,7 @@ Read the [contribution guidelines](/CONTRIBUTING.md) before contributing.
4646

4747
## Figma and Sketch component kits
4848

49-
Use official component kits provided by [Material Design](https://material.io/resources).
49+
Use official component kits provided by [Material Design](https://m3.material.io/).
5050

5151
## Made with ❤️ at Callstack
5252

0 commit comments

Comments
 (0)