Skip to content

Commit 6a84a61

Browse files
committed
add CONTRIBUTING
1 parent 9948737 commit 6a84a61

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
Contributions are always welcome! Before contributing, please read the [code of conduct](https://github.com/WebComponentsGuide/webcomponents.guide/blob/main/CODE_OF_CONDUCT.md).
4+
5+
## Where to start
6+
7+
- If you've found typos or mistakes in the documentation, please go right ahead and raise a PR!.
8+
- If you're looking for issues to resolve, a good place to start is the [help wanted label](https://github.com/WebComponentsGuide/webcomponents.guide/labels/help%20wanted) and/or [good first issue label](https://github.com/WebComponentsGuide/webcomponents.guide/labels/good%20first%20issue).
9+
- If you have to contribute to bigger pieces, like an idea or new section, tutorial, or blog post, then please raise an issue first! This way we can discuss an action plan and figure out a high level overview of what should be written.
10+
11+
### Setup
12+
13+
You can run the code locally by cloning the repository, and running `npm install` followed by `npm start`:
14+
15+
```sh
16+
$ git clone [email protected]:WebComponentsGuide/webcomponents.guide
17+
$ cd webcomponents.guide
18+
$ npm install
19+
$ npm start
20+
```
21+
22+
Once this is done you can visit http://localhost:8080/ to see the local copy of the website. As you edit files the website will automatically rebuild, and you can see the changes reflected in your browser.
23+
24+
### Running checks/tests
25+
26+
When making contributions, please make sure to run `npm run check`, to ensure your contributions are correctly formatted and spelled. You can also run `npm run format` to automatically format all files.

0 commit comments

Comments
 (0)