Skip to content

Commit b8a8b2a

Browse files
authored
Merge pull request #245 from hamsurang/feat/claude.md
feat: add CLAUDE.md
2 parents c7a8c4a + 20c39ca commit b8a8b2a

File tree

1 file changed

+118
-0
lines changed

1 file changed

+118
-0
lines changed

โ€ŽCLAUDE.mdโ€Ž

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Claude Translation Guidelines for React-Ko-Form
2+
3+
This document provides translation guidelines for React Hook Form documentation to ensure consistency when using Claude AI for translation tasks.
4+
5+
## Overview
6+
7+
React-Ko-Form maintains consistent Korean translations by following specific rules. When translating React Hook Form documentation, Claude should adhere to these guidelines to ensure uniformity across all translated content.
8+
9+
## Translation Rules
10+
11+
### 1. Standard Korean Translations
12+
13+
Translate the following terms consistently:
14+
15+
| English | Korean | Notes |
16+
|---------|--------|-------|
17+
| form | ํผ | |
18+
| method | ๋ฉ”์„œ๋“œ | |
19+
| submission | ์ œ์ถœ | Use English if "์ œ์ถœ" sounds awkward in context |
20+
| input | ์ธํ’‹ or ์ž…๋ ฅ | Context-dependent; choose based on readability |
21+
| error | ์—๋Ÿฌ | |
22+
| send | ์ „๋‹ฌ | |
23+
| submit | ์ „์†ก | |
24+
| prop | ์†์„ฑ | |
25+
| rerendering | ๋ฆฌ๋ Œ๋”๋ง | |
26+
27+
### 2. Bilingual Notation (Korean + English)
28+
29+
For technical terms that benefit from English clarification, use the format: `Korean(English)`
30+
31+
| English | Korean Notation |
32+
|---------|----------------|
33+
| register/registered | ๋“ฑ๋ก(register) |
34+
| blur | ๋ธ”๋Ÿฌ(blur) |
35+
| optional array | ์˜์กด์„ฑ ๋ฐฐ์—ด(optional array) |
36+
| flat field array | ํ‰๋ฉด ํ•„๋“œ ๋ฐฐ์—ด(flat field array) |
37+
| properties | ์†์„ฑ(properties) |
38+
| props | ์†์„ฑ(props) |
39+
| touched | ํ„ฐ์น˜๋œ(touched) |
40+
| dirty | ๋ณ€๊ฒฝ๋œ(dirty) |
41+
| render phase | ๋ Œ๋” ๋‹จ๊ณ„(render phase) |
42+
| export | ๋‚ด๋ณด๋‚ด๊ธฐ(export) |
43+
| dependency array | ์˜์กด์„ฑ ๋ฐฐ์—ด(dependency array) |
44+
45+
### 3. Keep in English
46+
47+
The following terms should remain in English as their Korean translations may lose technical precision:
48+
49+
- `flush`
50+
- `import`
51+
- `dispatch`
52+
53+
### 4. Section Titles
54+
55+
**Do NOT translate:**
56+
- Main section headings like: `Props`, `Examples`, `Rules`, `TypeScript`, `API`, etc.
57+
58+
**DO translate:**
59+
- Subtitles under these sections if they are descriptive phrases
60+
- Example: Under "Examples", a subtitle "Reset Field State" should be translated to "ํ•„๋“œ ์ƒํƒœ ์ดˆ๊ธฐํ™”"
61+
62+
## Prompt Template for Claude
63+
64+
When asking Claude to translate documentation, use this template:
65+
66+
```
67+
Please translate the following React Hook Form documentation to Korean following these guidelines:
68+
69+
1. Use the translation rules from claude.md in the repository
70+
2. Maintain all code examples and technical syntax unchanged
71+
3. Keep section headers (Props, Examples, Rules) in English
72+
4. Translate descriptive subtitles under main sections
73+
5. Use bilingual notation (Korean + English) for technical terms as specified
74+
6. Ensure consistency with existing translations in the project
75+
76+
[Paste the content to translate here]
77+
```
78+
79+
## Example Translation
80+
81+
**English:**
82+
```
83+
## Props
84+
85+
### name
86+
87+
The name of the input field. This prop is required and must be unique.
88+
89+
### rules
90+
91+
Validation rules for the register method. You can pass validation rules to register.
92+
```
93+
94+
**Korean:**
95+
```
96+
## Props
97+
98+
### name
99+
100+
์ธํ’‹ ํ•„๋“œ์˜ ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. ์ด ์†์„ฑ(prop)์€ ํ•„์ˆ˜์ด๋ฉฐ ๊ณ ์œ ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
101+
102+
### rules
103+
104+
๋“ฑ๋ก(register) ๋ฉ”์„œ๋“œ๋ฅผ ์œ„ํ•œ ๊ฒ€์ฆ ๊ทœ์น™์ž…๋‹ˆ๋‹ค. register์— ๊ฒ€์ฆ ๊ทœ์น™์„ ์ „๋‹ฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
105+
```
106+
107+
## Additional Resources
108+
109+
For the complete and up-to-date translation rules, please refer to:
110+
- [Translation Rules Wiki](https://github.com/hamsurang/react-ko-form/wiki/react%E2%80%90ko%E2%80%90form%EC%9D%98-%EB%B2%88%EC%97%AD-%EA%B7%9C%EC%B9%99)
111+
112+
## Notes for Contributors
113+
114+
- Always check existing translations for consistency
115+
- When in doubt, refer to the wiki or ask maintainers
116+
- Code examples should never be translated
117+
- Maintain the original formatting and markdown structure
118+
- Technical accuracy is paramount - if a Korean translation feels awkward or unclear, consider keeping the English term or using bilingual notation

0 commit comments

Comments
ย (0)