Skip to content

Commit

Permalink
docs: improve home page styling
Browse files Browse the repository at this point in the history
  • Loading branch information
hperrin committed Jun 20, 2023
1 parent 8584f93 commit 4405f62
Show file tree
Hide file tree
Showing 2 changed files with 216 additions and 219 deletions.
27 changes: 20 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,40 @@ Now let's get the repo set up for development.
```
cd smui
npm i
# This will take a while
npm run bootstrap
npm i
```

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

```
cd packages/site
npm run dev
```

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

## Making Changes to Packages

## Commiting Changes
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.

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.
## Committing Changes

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.

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.

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:

- `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.)
- `docs:` - A change to the READMEs, the demo site, or type descriptions.
- `style:` - A change to the code that doesn't affect the code at all. (Code style fixes, formatting.)
- `refactor:` - A change to the code that doesn't affect the functionality of the code or the API at all.
- `fix:` - A change to the code that fixes an issue without changing the API.
- `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.

Remember to include `BREAKING CHANGE:` in the commit message footer if it changes the API in a backward incompatible way.

Once you've made your change, feel free to open a pull request.

Happy coding, and thanks again for contributing!
Loading

0 comments on commit 4405f62

Please sign in to comment.