Skeletonic Stylus is an open-source project; contributions of all sizes are welcome — from typo fixes to new components.
Quick start
# 1. Fork & clone
git clone git@github.com:YOUR-USER/skeletonic-stylus.git
cd skeletonic-stylus
# 2. Install (pnpm via corepack)
corepack enable
pnpm install
# 3. Build
pnpm run build # full pipeline (stylus → prettier → stylelint → autoprefixer → csso)
# 4. Lint & test
pnpm run lint
node scripts/a11y-test.mjs
Conventions
- Branch names:
feat/short-thing,fix/short-thing,docs/short-thing. - Commits: Conventional Commits. All commits are signed.
- Stylus: 4-space indent, no semicolons, prefer
$variablesover magic numbers, every public class lives in a cascade layer. - Accessibility: any new component must demonstrably meet WCAG 2.2 AA;
run
node scripts/a11y-test.mjsagainst the showcase before opening a PR. - Size budget: the core stylesheet must stay under 8 KB gzipped. If your change pushes it over, justify it in the PR.
Pull requests
- Open an issue first for anything non-trivial — saves rework.
- Keep PRs focused: one logical change per PR.
- Update the
CHANGELOG.mdunder "Unreleased". - Make sure CI is green before requesting review.
- Squash-merge is the default; commit messages will be cleaned up at merge.
Code of conduct
By participating, you agree to abide by the Contributor Covenant 2.1. Be kind, be patient, assume good intent.