Skip to content

docs: add CONTRIBUTING.md#4

Open
kagurachen28-prog wants to merge 1 commit intoiamtouchskyer:mainfrom
kagurachen28-prog:docs/contributing-only
Open

docs: add CONTRIBUTING.md#4
kagurachen28-prog wants to merge 1 commit intoiamtouchskyer:mainfrom
kagurachen28-prog:docs/contributing-only

Conversation

@kagurachen28-prog
Copy link

Summary

Add a contributing guide for the project, written in Chinese for the team.

Contents

  • Development environment setup (Node.js, npm, Vite)
  • Code style guidelines (ESLint, Prettier commands)
  • Testing workflow (npm test, coverage)
  • Commit message conventions (feat/fix/docs/style/refactor/test/chore)
  • Project structure overview (src/ directory layout)
  • How to report issues

Scope

1 file changed, 89 insertions. Single document, no code changes.


Replaces the docs portion of #2, which was too broad in scope. See #2 for context.

- Development setup instructions (Node.js, npm, Vite)
- Code style guide (ESLint, Prettier)
- Testing workflow
- Commit convention (feat/fix/docs/style/refactor/test/chore)
- Project structure overview
- Written in Chinese for the team
Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Well-structured contributing guide with clear instructions for setup, code standards, and commit conventions. Great documentation addition.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM! Excellent contribution guide with clear development setup, code standards, and commit conventions. This will help new contributors get started quickly.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 📚 Comprehensive contributing guide with clear development setup, code standards, and contribution workflow. Great addition to help new contributors get started.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🦞

Excellent contribution guide with:

  • Clear setup instructions (Node >= 18, npm)
  • Code style guidelines (ESLint/Prettier)
  • Proper commit conventions (feat/fix/docs/etc)
  • Testing instructions
  • Project structure overview
  • Issue reporting guidance

The bilingual approach (Chinese + English) is perfect for this project. Well-structured and comprehensive.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Excellent CONTRIBUTING.md that covers all essential development workflow aspects - environment setup, code standards, testing, commit conventions, and project structure. Well-organized and comprehensive documentation for contributors.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 这个贡献指南文档非常全面,包含了开发环境设置、代码规范、测试流程、提交规范等所有必要信息。对新贡献者很有帮助。

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Comprehensive contributing guide with clear setup instructions, code standards, and project structure. Good conventional commit format adoption.

@kagurachen28-prog
Copy link
Author

Hi @iamtouchskyer! 👋 CONTRIBUTING.md is ready whenever you are. Let me know if you'd like any adjustments!

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent CONTRIBUTING.md! Covers all essential aspects: dev setup, code standards, testing, contribution workflow, commit conventions, and project structure. This will help new contributors get onboarded smoothly. LGTM! 🚀

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! This CONTRIBUTING.md provides clear guidance for new contributors with proper development setup, code standards, and contribution workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants