Skip to content

Commit 7d9cc76

Browse files
committed
Updated contribution guide
1 parent 3973377 commit 7d9cc76

File tree

3 files changed

+24
-17
lines changed

3 files changed

+24
-17
lines changed

Diff for: CONTRIBUTION.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Contribution Guide
2-
- Before submitting a PR please create an issue to discuss it first (also make sure you have read **Goals** section)
3-
- 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)
4-
- To make changes in `README.md` edit `.md` files that are located in the `/docs/markdown` folder
5-
- To make changes in code snippets edit source files in `/playground` folder
6-
- include directives look like this: `::[example|usage]='../../playground/src/components/sfc-counter.tsx'::`
7-
8-
When submitting a PR please make sure that you run:
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).
4+
3. All workflow scripts (prettier, linter, tests) must pass successfully.
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+
- To make changes in `README.md` edit `.md` files that are located in the `/docs/markdown` folder
7+
- To make changes in code snippets edit source files in `/playground` folder
8+
- include directives look like this: `::[example|usage]='../../playground/src/components/sfc-counter.tsx'::`
9+
5. When submitting a PR please make sure that you run the following:
910
```bash
1011
# run linter in `/playground` folder
1112
npm run lint

Diff for: README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,15 @@ _"This guide is a **living compendium** documenting the most important patterns
2828
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.
2929
> 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.
3030
31-
### Contribution Guide
32-
[CONTRIBUTION.md](/CONTRIBUTION.md)
31+
## Contribution Guide
32+
If you're planning to contribute please make sure to read the contribution guide: [CONTRIBUTION.md](/CONTRIBUTION.md)
3333

34-
### Sponsor
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!
36-
> This gives you the power to prioritize our work and support project contributors. Moreover it'll guarantee the project will be updated and maintained in the long run.
34+
## Sponsor
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!
36+
37+
This gives you the power to prioritize our work and support the project contributors. Moreover it'll guarantee the project will be updated and maintained in the long run.
38+
39+
> If you're a sponsor and want your logo to be featured in this repo under the sponsors section, please contact me at: [email protected]
3740
3841
[![issuehunt-image](https://github.com/BoostIO/issuehunt-materials/blob/master/[email protected]?raw=true)](https://issuehunt.io/repos/76996763)
3942

Diff for: docs/markdown/_intro.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,14 @@ _"This guide is a **living compendium** documenting the most important patterns
2828
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.
2929
> 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.
3030
31-
### Contribution Guide
32-
[CONTRIBUTION.md](/CONTRIBUTION.md)
31+
## Contribution Guide
32+
If you're planning to contribute please make sure to read the contribution guide: [CONTRIBUTION.md](/CONTRIBUTION.md)
3333

34-
### Sponsor
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!
36-
> This gives you the power to prioritize our work and support the project contributors. Moreover it'll guarantee the project will be updated and maintained in the long run.
34+
## Sponsor
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!
36+
37+
This gives you the power to prioritize our work and support the project contributors. Moreover it'll guarantee the project will be updated and maintained in the long run.
38+
39+
> If you're a sponsor and want your logo to be featured in this repo under the sponsors section, please contact me at: [email protected]
3740
3841
[![issuehunt-image](https://github.com/BoostIO/issuehunt-materials/blob/master/[email protected]?raw=true)](https://issuehunt.io/repos/76996763)

0 commit comments

Comments
 (0)