docs: redesign README and add contributor guidelines#575
Merged
Conversation
- Redesign README.md and README_zh_cn.md for better readability - Add "Why JEngine?" section highlighting key benefits - Remove repobeats analytics image - Enhance package descriptions with JAction/JObjectPool details - Separate core (required) and optional packages - Create CONTRIBUTING.md with development setup, code style, commit conventions, DCO requirements, and PR process Signed-off-by: Jason Xu <jasonxudeveloper@gmail.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Code ReviewFound 1 issue that needs attention: File Header Format InconsistencyFile: CONTRIBUTING.md, lines 99-100 The C# file header format shown in CONTRIBUTING.md differs from the format specified in CLAUDE.md. CLAUDE.md specifies: // FileName.cs
//
// Author:
// JasonXuDeveloper <jason@xgamedev.net>
//
// Copyright (c) 2025 JEngine
//
// [MIT License...]CONTRIBUTING.md shows: // FileName.cs
//
// Author: JasonXuDeveloper <jason@xgamedev.net>
// Copyright (c) 2025 JEngine - MIT LicenseKey differences:
Impact: This inconsistency could confuse contributors and lead to non-uniform file headers across the codebase. Recommendation: Update CONTRIBUTING.md lines 99-100 to match the CLAUDE.md format exactly. |
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
README Enhancements (Both Languages)
# JEnginetitle中文文档New CONTRIBUTING.md
Comprehensive contributor guide covering:
Test plan
🤖 Generated with Claude Code