Skip to content

Commit c8b603a

Browse files
authored
chore: improve CONTRIBUTING.md and fix broken links (toss#324)
1 parent d02f912 commit c8b603a

5 files changed

Lines changed: 57 additions & 3 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
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)

README-ko_kr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ packages/
9292

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

95-
[CONTRIBUTING](./CONTRIBUTING.md)
95+
[CONTRIBUTING](./.github/CONTRIBUTING.md)
9696

9797
## 라이선스
9898

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ packages/
9292

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

95-
[CONTRIBUTING](./CONTRIBUTING.md)
95+
[CONTRIBUTING](./.github/CONTRIBUTING.md)
9696

9797
## License
9898

docs/core/contributing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,11 @@ yarn changeset
295295

296296
3. Write a brief summary of your changes.
297297

298+
::: tip
299+
Both packages are currently in the `0.0.x` stage. During this phase, most changes should use `patch`.
300+
If you're unsure about the version type, please discuss with the maintainers.
301+
:::
302+
298303
4. Commit the generated changeset file with your PR.
299304

300305
::: tip

docs/mobile/contributing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ Select the type of change:
8989
- `minor`: New features (maintaining backward compatibility)
9090
- `major`: Breaking changes (breaking backward compatibility)
9191

92+
::: tip
93+
Both packages are currently in the `0.0.x` stage. During this phase, most changes should use `patch`.
94+
If you're unsure about the version type, please discuss with the maintainers.
95+
:::
96+
9297
## Mobile-Specific Guidelines
9398

9499
### Testing on Real Devices

0 commit comments

Comments
 (0)