Skip to content

Commit 66f4c7e

Browse files
authored
chore: create contributing guidelines
Closes #177
1 parent c4f9bcd commit 66f4c7e

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

CONTRIBUTING.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
Thank you for contributing!
4+
5+
Svelte Material UI is a mature library, but is always looking for ways to improve. If you'd like to contribute, there are some guidelines you should know. First, let's get you started.
6+
7+
## Setting up Your Dev Environment
8+
9+
The first step is to fork the repo. Once you've got your own fork, check it out locally.
10+
11+
```
12+
git clone git@github.com:yourusername/svelte-material-ui.git smui
13+
```
14+
15+
Now you'll need lerna to get going. You can install it globally or you can run it with `npx`. I'm going to assume you want to install it globally.
16+
17+
```
18+
npm install -g lerna
19+
```
20+
21+
Now let's get the repo set up for development.
22+
23+
```
24+
cd smui
25+
26+
npm i
27+
28+
# This will take a while
29+
lerna bootstrap
30+
31+
cd site
32+
npm i
33+
```
34+
35+
Now you're set up. If there are package-lock.json files updated after setting up, feel free to reset those changes. Run this in the site folder to start up the dev site.
36+
37+
```
38+
npm run dev
39+
```
40+
41+
Once that starts, you should be able to see the site at http://localhost:5000 and the site will refresh automatically when you make a change.
42+
43+
## Commiting Changes
44+
45+
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.
46+
47+
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.
48+
49+
Once you've made your change, feel free to open a pull request.
50+
51+
Happy coding, and thanks again for contributing!

0 commit comments

Comments
 (0)