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
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,16 +18,17 @@ Before reporting an issue, ensure that you:
18
18
19
19
- have tried providing a [REPL](https://svelte.dev/repl/9982308600f043f3aeb43fb3b17f35b5?version=3.37.0)
20
20
21
-
## Setting up your environment
21
+
## Working on Svelte Materialify
22
+
### Setting up your environment
22
23
23
24
Follow these instructions if you are planning to make a pull request.
24
25
25
-
## Getting the source
26
+
###Getting the source
26
27
27
28
1. Register to [Github](https://github.com/)
28
29
2. Navigate to [svelte-materialify](https://github.com/TheComputerM/svelte-materialify)
29
30
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
+
4. Copy the url of your browser, it should now be: `https://github.com/{your_github_user_id}/svelte-materialify`
31
32
5. On your PC, open a command prompt window and type the following commands
32
33
33
34
```shell
@@ -37,7 +38,7 @@ $ cd svelte-materialify
37
38
38
39
This will get the entire repository on your machine, now we can build the library.
39
40
40
-
## Building
41
+
###Building
41
42
42
43
Building is done with yarn (**not** npm).
43
44
From the **root folder**, install the dependencies by typing:
@@ -64,12 +65,21 @@ To build the API, which provides the definitions and types for the different pro
64
65
yarn api
65
66
```
66
67
67
-
## Submitting your change
68
+
###Submitting your change
68
69
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).
70
+
After making a change, make sure it works well by running:
71
+
```shell
72
+
yarn lint
73
+
```
74
+
and
75
+
```shell
76
+
yarn test
77
+
```
78
+
Please commit your changes following [conventional commit syntax](https://github.com/conventional-changelog/commitlint/#what-is-commitlint), for example:
79
+
```shell
80
+
git commit -m "docs: improve contributing.md"
81
+
```
70
82
71
-
For example:
72
-
`docs: improve contributing.md`
83
+
Then, **git push** your changes to your github repository.
73
84
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.
85
+
Finally, from the github repository web page, you can click the **Pull Request** button and a contributor will review the changes you made.
Copy file name to clipboardExpand all lines: packages/docs/src/routes/getting-started/usage.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ In your svelte files, import the _uncompiled_ module `from 'svelte-materialify/s
43
43
```
44
44
## Layout
45
45
46
-
All components should be children of `MaterialApp`, which has all the **global styles** and enables theming:
46
+
All components should be children of `MaterialApp`, which provides all the **global styles** and enables theming:
47
47
48
48
```html
49
49
<script>
@@ -71,7 +71,8 @@ If you don't want any global styles (other than theming and colors), you can use
71
71
72
72
## Theming
73
73
74
-
You want to customise some SCSS variables? Worry not, just put them in the **\_material-theme.scss** you had created:
74
+
You want to customise some SCSS variables?
75
+
Worry not, just put them in the **\_material-theme.scss** you had created:
75
76
76
77
```scss
77
78
$primary-color: #004d26;
@@ -93,6 +94,6 @@ To access these variables in your own components, just import the variable file
93
94
94
95
<Components.Alert type='info'>
95
96
96
-
If you want to use SCSS and SASS styles in your own components, [use svelte-preprocess](https://github.com/sveltejs/svelte-preprocess/blob/master/docs/usage.md).
97
+
If you want to use SCSS and SASS styles in your own components, [use svelte-preprocess](https://github.com/sveltejs/svelte-preprocess/blob/main/docs/usage.md).
0 commit comments