Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (49 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 1.79 KB
Raw

Contributing to FrameLab

Thanks for contributing to FrameLab.

This repository is an early prototype and demo site for the FrameLab concept. Contributions should keep the project focused, readable, and easy to evaluate.

What to Contribute

Good contributions include:

  • Improvements to the demo site and project clarity
  • Better explanations of the FrameLab concept
  • Refinements to the prototype runtime
  • Fixes for bugs, broken styling, or build issues
  • Small, focused experiments that support the design-first UI direction

Avoid unrelated framework churn, large refactors without clear benefit, or changes that dilute the core concept.

Development Setup

Install dependencies:

npm install

Run the local dev server:

npm run dev

Run linting:

npm run lint

Create a production build:

npm run build

Contribution Guidelines

  • Keep changes focused and easy to review
  • Preserve the core FrameLab positioning and terminology
  • Prefer clear code over clever abstractions
  • Follow the existing React, TypeScript, and Vite setup
  • Update documentation when behavior, structure, or messaging changes

Pull Requests

When opening a pull request:

  • Explain what changed
  • Explain why the change improves the project
  • Include screenshots for visible UI changes when relevant
  • Keep PRs scoped to a single idea when possible

Issues

If you are reporting a bug or proposing a feature, include enough context to reproduce the problem or evaluate the idea quickly.

Useful details:

  • What you expected
  • What actually happened
  • Steps to reproduce
  • Screenshots or code samples when helpful

Project Direction

FrameLab is still exploratory. Not every contribution needs to be production-hardened, but it should move the idea forward in a clear and defensible way.