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
+20-7Lines changed: 20 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -17,27 +17,40 @@ Now let's get the repo set up for development.
17
17
```
18
18
cd smui
19
19
20
-
npm i
21
-
22
20
# This will take a while
23
-
npm run bootstrap
21
+
npm i
24
22
```
25
23
26
-
Now you're set up. If there are package-lock.json files updated after setting up, feel free to reset those changes. Run this to start up the dev site.
24
+
Now you're set up. If there are package-lock.json files in the package directories after setting up, feel free to delete them. Run this to start up the dev site.
27
25
28
26
```
29
27
cd packages/site
30
28
npm run dev
31
29
```
32
30
33
-
Once that starts, you should be able to see the site at http://localhost:3000/ and the site will refresh automatically when you make a change. You will have to go into whichever package you're working on and run `npm run build` before you'll see the change.
31
+
Once that starts, you should be able to see the site at http://127.0.0.1:5173/ and the site will refresh automatically when you make a change.
32
+
33
+
## Making Changes to Packages
34
34
35
-
## Commiting Changes
35
+
If your changes apply to a package rather than the site, you will have to go into whichever package you're working on and run `npm run build` before you'll see the change.
36
36
37
-
SMUI uses Prettier to format code. You should use Prettier after you've edited a file before you commit it. You can set up your editor to run Prettier automatically when you save a file. Also, don't forget the Svelte Prettier plugin.
37
+
## Committing Changes
38
+
39
+
SMUI uses Prettier to format code. You should use Prettier after you've edited a file, before you commit it. You can set up your editor to run Prettier automatically when you save a file. Also, don't forget the Svelte Prettier plugin.
38
40
39
41
SMUI uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages, and Husky will lint your commit messages when you commit. Please follow the conventional commits format for you commit messages. Please also provide meaningful, informative messages.
40
42
43
+
Personally, I don't scope my commit messages by package. It's fine if you do, but you'll be the odd commit out. Here are the types of commits and how I use them:
44
+
45
+
-`chore:` - A change that doesn't have any impact on documentation, the built code/styles, or the API. (Things like dependency updates, npm script changes, etc.)
46
+
-`docs:` - A change to the READMEs, the demo site, or type descriptions.
47
+
-`style:` - A change to the code that doesn't affect the code at all. (Code style fixes, formatting.)
48
+
-`refactor:` - A change to the code that doesn't affect the functionality of the code or the API at all.
49
+
-`fix:` - A change to the code that fixes an issue without changing the API.
50
+
-`feat:` - A change to the code that changes the API. Also any dependency updates that change the upstream API, like updating to a new MDC-Web version.
51
+
52
+
Remember to include `BREAKING CHANGE:` in the commit message footer if it changes the API in a backward incompatible way.
53
+
41
54
Once you've made your change, feel free to open a pull request.
0 commit comments