Skip to content

Commit 4405f62

Browse files
committed
docs: improve home page styling
1 parent 8584f93 commit 4405f62

File tree

2 files changed

+216
-219
lines changed

2 files changed

+216
-219
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,40 @@ Now let's get the repo set up for development.
1717
```
1818
cd smui
1919
20-
npm i
21-
2220
# This will take a while
23-
npm run bootstrap
21+
npm i
2422
```
2523

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.
2725

2826
```
2927
cd packages/site
3028
npm run dev
3129
```
3230

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
3434

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.
3636

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.
3840

3941
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.
4042

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+
4154
Once you've made your change, feel free to open a pull request.
4255

4356
Happy coding, and thanks again for contributing!

0 commit comments

Comments
 (0)