Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (28 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.6 KB

Contributing to react-simplikit

Welcome! We appreciate your interest in contributing to react-simplikit. This document provides an overview of how to contribute. For detailed guidelines, please refer to the package-specific contributing guides linked below.

Contributing Guide

Each contribution requires:

  • Implementation — following our Design Principles
  • Test Code — 100% coverage required
  • JSDoc — documentation is auto-generated from JSDoc, so no separate docs needed

For detailed instructions, see the package-specific guides:

Scaffolding

Use the scaffold command to create a basic structure for new implementations:

yarn run scaffold <name> --type <type>
  • type: component, hook, or util (shortcuts: c, h, u)
  • name: Name of the implementation

Creating a Changeset

When your changes affect a package, create a changeset:

yarn changeset

Select the version bump type (patch, minor, or major).

Note: Both packages are currently in the 0.0.x stage. During this phase, most changes should use patch. If you're unsure about the version type, please discuss with the maintainers.

Useful Links