Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (27 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 1.06 KB

Contributing

Feel free to dive in! Open an issue, start a discussion or submit a PR. For any informal concerns or feedback, please join our Discord server.

Contributions to Sablier Docs are welcome by anyone interested in improving readability, or adding new features.

Prerequisites

  • Node.js (v20+)
  • Just (command runner)
  • Bun (package manager)
  • Ni (package manager resolver)

Setup

git clone https://github.com/sablier-labs/docs.git sablier-docs
cd sablier-docs
bun install

Available Commands

just --list                 # Show all available commands
just start                  # Build the docs site locally on localhost:3000
just full-check             # Run all code checks

Development Workflow

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run just full-check to verify code quality
  5. Submit a pull request