Skip to content

Commit 9682ac9

Browse files
docs: add guidelines for creating new JEngine packages
- New packages should start at version 0.0.0 - Document naming convention and required files - Add ui scope to commit message conventions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
1 parent 97ee140 commit 9682ac9

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CLAUDE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,39 @@ public static bool Flag => _flag;
160160
3. Add menu items via `[MenuItem]` attribute
161161
4. Handle domain reloads if maintaining state
162162

163+
### Creating New JEngine Packages
164+
165+
When creating a new JEngine package:
166+
167+
1. **Version**: Start at `0.0.0` (not `1.0.0`)
168+
2. **Naming**: Use `com.jasonxudeveloper.jengine.<name>` format
169+
3. **Location**: `Packages/com.jasonxudeveloper.jengine.<name>/`
170+
4. **Required files**:
171+
- `package.json` - Package manifest with version `0.0.0`
172+
- `Runtime/<Name>.asmdef` - Assembly definition
173+
- `README.md` - Package documentation (optional)
174+
175+
Example `package.json`:
176+
```json
177+
{
178+
"name": "com.jasonxudeveloper.jengine.<name>",
179+
"version": "0.0.0",
180+
"displayName": "JEngine.<Name>",
181+
"description": "Description here.",
182+
"license": "MIT",
183+
"unity": "2022.3",
184+
"author": {
185+
"name": "Jason Xu",
186+
"email": "jason@xgamedev.com",
187+
"url": "https://github.com/JasonXuDeveloper"
188+
},
189+
"dependencies": {}
190+
}
191+
```
192+
193+
5. **CI Updates**: Add package path to `.github/workflows/pr-tests.yml` and release support to `.github/workflows/release.yml`
194+
6. **Scopes**: Add new scope to commit message conventions
195+
163196
## Code Review Checklist
164197

165198
- [ ] Follows namespace conventions
@@ -199,6 +232,7 @@ All commits should follow the Conventional Commits specification to enable autom
199232

200233
- `core` - Changes to JEngine.Core package
201234
- `util` - Changes to JEngine.Util package
235+
- `ui` - Changes to JEngine.UI package
202236
- `ci` - Changes to CI/CD workflows
203237
- `docs` - Changes to documentation
204238

0 commit comments

Comments
 (0)