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
{{ message }}
This repository was archived by the owner on Sep 26, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: packages/docs/src/routes/getting-started/contributing.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,25 +10,25 @@ If you would like to contribute to svelte materialify and improve its functional
10
10
11
11
## Reporting Issues
12
12
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:
14
14
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
16
16
17
-
-Reproduction as to be **minimal** and consise.
17
+
-have a **minimal**, concise, reproducible example
18
18
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)
20
20
21
21
## Setting up your environment
22
22
23
23
Follow these instructions if you are planning to make a pull request.
24
24
25
-
## Get the source
25
+
## Getting the source
26
26
27
-
1. Register to [github](https://github.com/).
27
+
1. Register to [Github](https://github.com/)
28
28
2. Navigate to [svelte-materialify](https://github.com/TheComputerM/svelte-materialify)
29
29
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
This will get the entire repository on your machine, now we can build the library.
39
39
40
-
## Build
40
+
## Building
41
41
42
42
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:
44
44
45
45
```shell
46
46
yarn
47
47
```
48
48
49
-
Then to build the main library, svelte materialify itself.
49
+
Then build the main library, svelte materialify, itself:
50
50
51
51
```shell
52
52
yarn build
53
53
```
54
54
55
-
To build and develop the documentation site.
55
+
To build and develop the documentation site:
56
56
57
57
```shell
58
58
yarn dev
59
59
```
60
60
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:
62
62
63
63
```shell
64
64
yarn api
65
65
```
66
66
67
-
## Submit your change
67
+
## Submitting your change
68
68
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).
72
70
71
+
For example:
73
72
`docs: improve contributing.md`
74
73
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