Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (38 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

49 lines (38 loc) · 1.37 KB

Contributing

Contributions are welcome. This project is intentionally small (two source files), so most contributions will be bug fixes or small improvements.

Development Setup

git clone https://github.com/rbbydotdev/better-resizable-panels.git
cd better-resizable-panels
bun install

Project Structure

better-resizable-panels/
  index.html                              # Demo site (GitHub Pages)
  registry/better-resizable-panels/
    resizable-panels.tsx                   # Main component + useResizable hook
    use-local-storage.ts                  # localStorage sync hook
  registry.json                           # shadcn registry definition
  r/                                      # Built registry output

Making Changes

  1. Fork the repository
  2. Create a branch: git checkout -b fix/description
  3. Edit files in registry/better-resizable-panels/
  4. Test by installing into a local shadcn project: 
    npx shadcn@latest add ./r/resizable-panels.json
  5. Rebuild the registry: bun run build:registry
  6. Open a pull request

Code Style

  • TypeScript with strict mode
  • Tailwind CSS for styling
  • No runtime dependencies beyond React and Tailwind
  • Keep the component in a single file

Reporting Issues

Open an issue with:

  • What happened vs. what was expected
  • Browser and React version
  • Minimal reproduction if possible