Skip to content
This repository was archived by the owner on Sep 26, 2022. It is now read-only.

Commit abde05a

Browse files
docs: better contributing advice
Signed-off-by: Florian-Schoenherr <[email protected]>
1 parent 56baac3 commit abde05a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

packages/docs/src/routes/getting-started/contributing.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@ If you would like to contribute to svelte materialify and improve its functional
1010

1111
## Reporting Issues
1212

13-
It is important to keep your setup to a **minimum** so if you can it is better to reproduce the bug in the [repl playground](https://svelte.dev/repl/2c55788d8ffd4458bfe9bcb5f58956db). Before reporting an issue, ensure that:
13+
Before reporting an issue, ensure that you:
1414

15-
- Search for a similar [issues](https://github.com/TheComputerM/svelte-materialify/issues), it may have been answered.
15+
- searched for similar [issues](https://github.com/TheComputerM/svelte-materialify/issues), it may have been answered already
1616

17-
- Reproduction as to be **minimal** and consise.
17+
- have a **minimal**, concise, reproducible example
1818

19-
- If possible try running the code in the [repl playground](https://svelte.dev/repl/2c55788d8ffd4458bfe9bcb5f58956db).
19+
- have tried providing a [REPL](https://svelte.dev/repl/9982308600f043f3aeb43fb3b17f35b5?version=3.37.0)
2020

2121
## Setting up your environment
2222

2323
Follow these instructions if you are planning to make a pull request.
2424

25-
## Get the source
25+
## Getting the source
2626

27-
1. Register to [github](https://github.com/).
27+
1. Register to [Github](https://github.com/)
2828
2. Navigate to [svelte-materialify](https://github.com/TheComputerM/svelte-materialify)
2929
3. Press the fork button in the top right corner of the screen
30-
4. Copy the url of your browser, it should now be : https://github.com/**your_github_user_id**/svelte-materialify
31-
5. On your PC open a command prompt window and type the following commands
30+
4. Copy the url of your browser, it should now be: https://github.com/**your_github_user_id**/svelte-materialify
31+
5. On your PC, open a command prompt window and type the following commands
3232

3333
```shell
3434
$ git clone https://github.com/{your_github_user_id}/svelte-materialify.git
@@ -37,39 +37,39 @@ $ cd svelte-materialify
3737

3838
This will get the entire repository on your machine, now we can build the library.
3939

40-
## Build
40+
## Building
4141

4242
Building is done with yarn (**not** npm).
43-
From the root folder, install the dependencies by typing:
43+
From the **root folder**, install the dependencies by typing:
4444

4545
```shell
4646
yarn
4747
```
4848

49-
Then to build the main library, svelte materialify itself.
49+
Then build the main library, svelte materialify, itself:
5050

5151
```shell
5252
yarn build
5353
```
5454

55-
To build and develop the documentation site.
55+
To build and develop the documentation site:
5656

5757
```shell
5858
yarn dev
5959
```
6060

61-
Then you can build the API, which provides the definitions and types for the different props/events/slots for the components.
61+
To build the API, which provides the definitions and types for the different props/events/slots of the components:
6262

6363
```shell
6464
yarn api
6565
```
6666

67-
## Submit your change
67+
## Submitting your change
6868

69-
First make a change and make sure it works well by running `yarn lint` and `yarn test`, then commit your changes following [this syntax](https://github.com/conventional-changelog/commitlint/#what-is-commitlint).
70-
71-
For example here
69+
After making a change, make sure it works well by running `yarn lint` and `yarn test`, then commit your changes following [conventional commit syntax](https://github.com/conventional-changelog/commitlint/#what-is-commitlint).
7270

71+
For example:
7372
`docs: improve contributing.md`
7473

75-
Then push your changes to your github repository, finally from the github repository web page you can click the Pull Request button and a contributor will review the changes you made.
74+
Then, push your changes to your github repository.
75+
Finally, from the github repository web page, you can click the Pull Request button and a contributor will review the changes you made.

0 commit comments

Comments
 (0)