You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contribution Guide
1
+
# Contributing Guide
2
2
1. Make sure you have read and understand the **Goals** section to be aligned with project goals.
3
-
2. Before submitting a PR please comment in the existing issue (or create a new one if necessary) to discuss the planned work (this will prevent rejecting the PR and wasting your work).
3
+
2. Before submitting a PR please comment in the relevant issue (or create a new one if it doesn't exist yet) to discuss all the requirements (this will prevent rejecting the PR and wasting your work).
4
4
3. All workflow scripts (prettier, linter, tests) must pass successfully.
5
5
4. Don't edit `README.md` directly - it is built using `sh ./generate.sh` script to inject code snippets from the sources in the `/playground` folder (this will make sure all code examples are nicely formatted and working)
6
6
- To make changes in `README.md` edit `.md` files that are located in the `/docs/markdown` folder
Copy file name to clipboardExpand all lines: README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,8 @@ _"This guide is a **living compendium** documenting the most important patterns
28
28
You should check out Playground Project located in the `/playground` folder. It is a source of all the code examples found in the guide. They are all tested with the most recent version of TypeScript and 3rd party type definitions (like `@types/react` or `@types/react-redux`) to ensure the examples are up-to-date and not broken with updated definitions.
29
29
> Playground was created in such a way that you can simply clone the repository locally and immediately play around on your own. It will help you to learn all the examples from this guide in a real project environment without the need to create some complicated environment setup by yourself.
30
30
31
-
## Contribution Guide
32
-
If you're planning to contribute please make sure to read the contribution guide: [CONTRIBUTION.md](/CONTRIBUTION.md)
31
+
## Contributing Guide
32
+
If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
33
33
34
34
## Sponsor
35
35
If you like what we're doing here, you can help us by funding the work on specific issues that you choose by using IssueHunt.io!
Copy file name to clipboardExpand all lines: docs/markdown/_intro.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,8 @@ _"This guide is a **living compendium** documenting the most important patterns
28
28
You should check out Playground Project located in the `/playground` folder. It is a source of all the code examples found in the guide. They are all tested with the most recent version of TypeScript and 3rd party type definitions (like `@types/react` or `@types/react-redux`) to ensure the examples are up-to-date and not broken with updated definitions.
29
29
> Playground was created in such a way that you can simply clone the repository locally and immediately play around on your own. It will help you to learn all the examples from this guide in a real project environment without the need to create some complicated environment setup by yourself.
30
30
31
-
## Contribution Guide
32
-
If you're planning to contribute please make sure to read the contribution guide: [CONTRIBUTION.md](/CONTRIBUTION.md)
31
+
## Contributing Guide
32
+
If you're planning to contribute please make sure to read the contributing guide: [CONTRIBUTING.md](/CONTRIBUTING.md)
33
33
34
34
## Sponsor
35
35
If you like what we're doing here, you can help us by funding the work on specific issues that you choose by using IssueHunt.io!
0 commit comments