Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
# CONTRIBUTING
# 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](https://react-simplikit.slash.page/core/design-principles.html)
- **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:

- [Core Package Contributing Guide](../docs/core/contributing.md)
- [Mobile Package Contributing Guide](../docs/mobile/contributing.md)

## Scaffolding

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

```bash
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:

```bash
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

- [Documentation Site](https://react-simplikit.slash.page)
- [Design Principles](https://react-simplikit.slash.page/core/design-principles.html)
- [Discord](https://discord.gg/vGXbVjP2nY)
2 changes: 1 addition & 1 deletion README-ko_kr.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ packages/

커뮤니티의 모든 분들의 기여를 환영해요! 기여 가이드를 확인하세요.

[CONTRIBUTING](./CONTRIBUTING.md)
[CONTRIBUTING](./.github/CONTRIBUTING.md)

## 라이선스

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ packages/

We welcome contributions from everyone! Please check our contribution guide.

[CONTRIBUTING](./CONTRIBUTING.md)
[CONTRIBUTING](./.github/CONTRIBUTING.md)

## License

Expand Down
5 changes: 5 additions & 0 deletions docs/core/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,11 @@ yarn changeset

3. Write a brief summary of your changes.

::: tip
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.
:::

4. Commit the generated changeset file with your PR.

::: tip
Expand Down
5 changes: 5 additions & 0 deletions docs/mobile/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ Select the type of change:
- `minor`: New features (maintaining backward compatibility)
- `major`: Breaking changes (breaking backward compatibility)

::: tip
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.
:::

## Mobile-Specific Guidelines

### Testing on Real Devices
Expand Down
Loading