Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (81 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

120 lines (81 loc) · 2.92 KB
Raw

Contributing

We welcome contributions to our project! This guide will help you get started with development and contributing to the blocks registry.

Development

Prerequisites

  • Bun - This project uses Bun as the package manager
  • Node.js 18+ - Required for Next.js

Getting Started

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/blocks.git
cd blocks

  3. Install dependencies:

    bun install

  4. Start the development server:

    bun run dev

    The development server will be available at http://localhost:3000.

Scripts

# Development
bun run dev              # Start dev server with Turbopack
bun run build            # Build the project
bun run start            # Start production server

# Registry Management
bun run generate:registry    # Generate registry.json
bun run validate:registry    # Validate registry structure

# Code Quality
bunx ultracite lint         # Lint codebase with Biome

Project Structure

blocks/
├── app/                    # Next.js app router pages
├── components/             # Shared UI components
├── content/
│   ├── components/         # Block implementations
│   ├── blocks-metadata.ts  # Block registry metadata
│   └── blocks-categories.tsx # Category definitions
├── lib/                    # Utility functions
├── public/
│   └── r/                  # Registry JSON files
├── scripts/                # Build and generation scripts
└── registry.json           # Main registry file

Adding New Blocks

We'd love your block contributions! To keep the library well-organized, we ask that you add blocks to existing categories rather than creating new ones. If you have ideas for a new category, feel free to open an issue to discuss it with the maintainers.

Existing categories can be found in content/blocks-categories.tsx.

  1. Add the component to content/components/{category}/{block-id}.tsx
  2. Add the metadata to content/blocks-metadata.ts
  3. Generate the registry with bun run generate:registry

See CLAUDE.md for detailed development guidelines.

Contributing Process

  1. Create a new branch for your feature or bug fix:

    git checkout -b your-branch-name

  2. Make your changes to the codebase.

  3. Build and test the project:

    bun run build

  4. Test the application to ensure your changes work as expected.

  5. Run linting to ensure code quality:

    bunx ultracite lint

  6. Commit your changes:

    git commit -m "Your descriptive commit message"

  7. Push your changes to your fork:

    git push -u origin your-branch-name

  8. Open a pull request on the original repository.

Thank you for contributing to our project!