Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (79 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

113 lines (79 loc) · 2.28 KB

Contributing to Fict

Thank you for your interest in contributing to Fict!

Prerequisites

  • Node.js 20+
  • pnpm 9+

Development Setup

# Clone the repository
git clone https://github.com/fictjs/fict.git
cd fict

# Install dependencies
pnpm install

# Install git hooks
pnpm prepare

# Start development
pnpm dev

Project Structure

  • packages/runtime - Core reactive runtime
  • packages/compiler - Babel compiler
  • packages/vite-plugin - Vite integration
  • packages/eslint-plugin - ESLint rules
  • packages/devtools - Browser DevTools
  • packages/docs-site - Documentation website
  • packages/testing-library - Testing library
  • packages/ssr - Server-side rendering
  • examples/ - Example applications

Development Workflow

Running Tests

pnpm test           # Run all tests
pnpm test:watch     # Watch mode
pnpm test:coverage  # With coverage

Fine-grained DOM (only mode)

  • The TypeScript transformer emits fine-grained DOM bindings by default; set fineGrainedDom: false in your tsconfig plugin entry only when bisecting regressions.
  • The runtime uses fine-grained updates exclusively. All components benefit from surgical DOM updates and node reuse.

Code Quality

pnpm lint          # ESLint
pnpm typecheck     # TypeScript
pnpm format        # Prettier

Building

pnpm build                    # Build all packages
pnpm build --filter @fictjs/runtime  # Build specific package

Commit Convention

pnpm commit

Examples:

  • feat(runtime): add batch update support
  • fix(compiler): handle edge case in JSX transform
  • docs: update API reference

Creating a Changeset

When making changes that should be released:

pnpm changeset

Follow the prompts to:

  1. Select changed packages
  2. Choose version bump type
  3. Write a summary

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/amazing-feature)
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass (pnpm test)
  6. Add a changeset if needed (pnpm changeset)
  7. Commit your changes
  8. Push to your fork
  9. Open a Pull Request

Code of Conduct

Please be respectful and constructive in all interactions.

Questions?

Open an issue or start a discussion on GitHub.