Skip to content

Develop - #1

Merged
FrankieLiu04 merged 4 commits into
mainfrom
develop
Jan 6, 2026
Merged

Develop#1
FrankieLiu04 merged 4 commits into
mainfrom
develop

Conversation

@FrankieLiu04

Copy link
Copy Markdown
Owner

This pull request introduces essential project meta files and documentation to standardize contribution, enforce code style, and clarify community standards. It adds configuration for code formatting, issue and PR templates, a license, and both English and Chinese versions of community and contributing guidelines. Minor code comments in original-labs/stable.c are also translated to English for clarity.

Key changes include:

Project Governance and Community Standards

  • Added CODE_OF_CONDUCT.md and CODE_OF_CONDUCT.zh-CN.md to define behavioral expectations for contributors in both English and Chinese. [1] [2]
  • Added CONTRIBUTING.md and CONTRIBUTING.zh-CN.md with detailed contribution workflows, branch strategies, commit conventions, and development environment setup, in both English and Chinese. [1] [2]
  • Added MIT LICENSE file to clarify project licensing and usage rights.

Development Workflow and Templates

  • Introduced .github/ISSUE_TEMPLATE/bug_report.md and .github/ISSUE_TEMPLATE/feature_request.md for standardized bug and feature reporting (in Chinese). [1] [2]
  • Added .github/PULL_REQUEST_TEMPLATE.md to guide contributors in submitting clear and consistent pull requests.

Code Style and Formatting

  • Added .clang-format for C++ code style enforcement based on Google style with project-specific adjustments.
  • Added .editorconfig to ensure consistent editor settings and file formatting across different file types and editors.

Documentation and Internationalization

  • Updated README.md to include a language badge linking to the Chinese version.

Codebase Minor Improvements

  • Translated several Chinese code comments in original-labs/stable.c to English for better accessibility and understanding. [1] [2] [3]

- Add MIT LICENSE
- Add CONTRIBUTING.md with branch strategy and commit conventions
- Add CODE_OF_CONDUCT.md
- Add GitHub Issue templates (bug report, feature request)
- Add Pull Request template
- Add .editorconfig for consistent coding style
- Add .clang-format for C++ code formatting
- Convert CONTRIBUTING.md and CODE_OF_CONDUCT.md to English
- Add Chinese versions as CONTRIBUTING.zh-CN.md and CODE_OF_CONDUCT.zh-CN.md
- Add language switcher badges for bilingual support
- Update PR template to English
- Translate .editorconfig comments
- Translate .clang-format comments
- Maintain consistency with English-first documentation policy
@FrankieLiu04
FrankieLiu04 merged commit 6b8d41c into main Jan 6, 2026
10 checks passed
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.

1 participant