Skip to content

contributing.md

Latest commit

 

History

History
34 lines (22 loc) · 754 Bytes

contributing.md

File metadata and controls

34 lines (22 loc) · 754 Bytes

drafting

Contributing

Before contributing to chart.xkcd you'll need a few things:

  • install npm

Setup

# install dependencies
npm i
# start examples (example/npm)
npm start

Then you can open localhost:1234 to see the examples, and you can start to edit the code. Thanks to parcel, the website will be auto updated when you make changes.

Layout

  • docs: Documentation used to generate timqian.com/chart.xkcd
  • examples: Examples showing how to use chart.xkcd. The npm example is also used for developing and debug features for now.
  • src: where the meat locates

Releases

Notes for myself:

  • before building chart.xkcd, shut down parcel server
  • npm run release(TODO)