|
1 | | -# CONTRIBUTING |
| 1 | +# Contributing to react-simplikit |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## Contributing Guide |
| 6 | + |
| 7 | +Each contribution requires: |
| 8 | + |
| 9 | +- **Implementation** — following our [Design Principles](https://react-simplikit.slash.page/core/design-principles.html) |
| 10 | +- **Test Code** — 100% coverage required |
| 11 | +- **JSDoc** — documentation is auto-generated from JSDoc, so no separate docs needed |
| 12 | + |
| 13 | +For detailed instructions, see the package-specific guides: |
| 14 | + |
| 15 | +- [Core Package Contributing Guide](../docs/core/contributing.md) |
| 16 | +- [Mobile Package Contributing Guide](../docs/mobile/contributing.md) |
| 17 | + |
| 18 | +## Scaffolding |
| 19 | + |
| 20 | +Use the scaffold command to create a basic structure for new implementations: |
| 21 | + |
| 22 | +```bash |
| 23 | +yarn run scaffold <name> --type <type> |
| 24 | +``` |
| 25 | + |
| 26 | +- `type`: `component`, `hook`, or `util` (shortcuts: `c`, `h`, `u`) |
| 27 | +- `name`: Name of the implementation |
| 28 | + |
| 29 | +## Creating a Changeset |
| 30 | + |
| 31 | +When your changes affect a package, create a changeset: |
| 32 | + |
| 33 | +```bash |
| 34 | +yarn changeset |
| 35 | +``` |
| 36 | + |
| 37 | +Select the version bump type (`patch`, `minor`, or `major`). |
| 38 | + |
| 39 | +> **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. |
| 40 | +
|
| 41 | +## Useful Links |
| 42 | + |
| 43 | +- [Documentation Site](https://react-simplikit.slash.page) |
| 44 | +- [Design Principles](https://react-simplikit.slash.page/core/design-principles.html) |
| 45 | +- [Discord](https://discord.gg/vGXbVjP2nY) |
0 commit comments