From 6692d991d700df9d1051ed800e244aa2543e5e27 Mon Sep 17 00:00:00 2001 From: kimyouknow Date: Thu, 12 Feb 2026 17:12:31 +0900 Subject: [PATCH] chore: improve CONTRIBUTING.md and fix broken links - Fill .github/CONTRIBUTING.md with contributing overview and useful links - Fix README/README-ko_kr links to point to .github/CONTRIBUTING.md - Add 0.0.x versioning tip to core and mobile contributing guides --- .github/CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++- README-ko_kr.md | 2 +- README.md | 2 +- docs/core/contributing.md | 5 ++++ docs/mobile/contributing.md | 5 ++++ 5 files changed, 57 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c6b9e95b..970fbd97 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 --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) diff --git a/README-ko_kr.md b/README-ko_kr.md index 5284493f..04aa634b 100644 --- a/README-ko_kr.md +++ b/README-ko_kr.md @@ -92,7 +92,7 @@ packages/ 커뮤니티의 모든 분들의 기여를 환영해요! 기여 가이드를 확인하세요. -[CONTRIBUTING](./CONTRIBUTING.md) +[CONTRIBUTING](./.github/CONTRIBUTING.md) ## 라이선스 diff --git a/README.md b/README.md index 3219e863..d5edefbf 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ packages/ We welcome contributions from everyone! Please check our contribution guide. -[CONTRIBUTING](./CONTRIBUTING.md) +[CONTRIBUTING](./.github/CONTRIBUTING.md) ## License diff --git a/docs/core/contributing.md b/docs/core/contributing.md index 14e238f3..9b387b74 100644 --- a/docs/core/contributing.md +++ b/docs/core/contributing.md @@ -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 diff --git a/docs/mobile/contributing.md b/docs/mobile/contributing.md index c5a98699..3a23db50 100644 --- a/docs/mobile/contributing.md +++ b/docs/mobile/contributing.md @@ -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