Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.58 KB
Raw

Contributing

Contributions are always welcome! Before contributing, please read the code of conduct.

Where to start

  • If you've found typos or mistakes in the documentation, please go right ahead and raise a PR!.
  • If you're looking for issues to resolve, a good place to start is the help wanted label and/or good first issue label.
  • If you're contributing to larger 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 we should write.
  • Reading the style guide will help you write content that fits with our intended style.

Setup

You can run the code locally by cloning the repository, and running npm install followed by npm start:

git clone git@github.com:WebComponentsGuide/webcomponents.guide
cd webcomponents.guide
npm install
npm start

You can now 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.

Running checks/tests

When making contributions, please make sure to run npm run check, to make sure your contributions are correctly formatted and spelled. You can also run npm run format to automatically format all files.