Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.67 KB
Raw

Contribution guide

Found a bug or have a question? Open an issue!

Want to create a pull request? Keep reading, but first off: just know that you're awesome and your contributions are very welcome.

Get started

This repo uses pnpm. If you have Node v16+, then installing it is straightforward using Corepack.

To run the repo:

  • Fork the repo, then clone your fork.
  • Open the cloned directory in your IDE (e.g. vscode or codespaces)
  • Run pnpm install to install dependencies.
  • Run pnpm run dev to start all dev servers in parallel.
  • Or run pnpm run build to build everything.

Directory structure

This project is a monorepo split into three folders:

  • package contains the actual code for the ecsstatic package.
  • docsite contains the documentation site hosted on ecsstatic.dev. This is built using astro.
  • demos contains subdirectories showing examples of how to use ecsstatic with other tools.

Documentation

The simplest docs updates can be done directly to the README.md.

For contributing actual docs, use the docsite folder. Astro knows how to render markdown pages as html, so any .md files can be added under docsite/src/pages.

Any changes that improve the visuals or accessibility of the website are also very welcome!