diff options
| -rw-r--r-- | CONTRIBUTING.md | 64 | ||||
| -rw-r--r-- | CONTRIBUTING_zh_CN.md | 64 |
2 files changed, 128 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1f0c5a6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# JustEnoughVCS Contribution Guide + +Welcome to the JustEnoughVCS (referred to as `JVCS`) project! Before you start contributing, please read this guide carefully to ensure a smooth contribution process. + +## Project Structure + +JustEnoughVCS adopts a modular architecture that separates core functionality from frontend tools into different repositories: + +### Core Repositories +- **Core Library**: https://github.com/JustEnoughVCS/VersionControl +- **Command Line Frontend**: https://github.com/JustEnoughVCS/CommandLine + +## Contribution Process + +### 1. Preparation + +**Core Library Contribution**: +- Fork the core repository to your GitHub account +- Clone it locally using SSH + +**Frontend Contribution**: +- Fork the corresponding frontend repository +- Clone it locally using SSH + +### 2. Project Directory Structure + +All frontend projects follow a unified directory structure: + +``` +. +├── <Frontend Name> +│ ├── src/ # Frontend source code +│ ├── Cargo.toml # Rust project configuration +│ └── README.md # Project documentation +└── VersionControl/ # Core library reference + ├── src/ + ├── Cargo.toml + ├── CONTRIBUTING.md + ├── LICENSE-MIT.md + └── README.md +``` + +### 3. Development Environment Setup + +1. Ensure you have the Rust toolchain installed +2. Clone the project locally +3. Configure the development environment according to the README instructions in each repository + +### 4. Submitting a Pull Request + +1. Create a feature branch in your forked repository +2. Implement your feature or fix +3. Write appropriate test cases +4. Ensure your code passes all existing tests +5. Write clear commit messages +6. Create a Pull Request to the main repository + +## Important Notes + +- Please ensure your code follows the project's coding standards +- Before submitting a PR, sync with the latest changes from the main repository +- For significant changes, it's recommended to discuss the design approach in Issues first + +Thank you for contributing to the JustEnoughVCS project! diff --git a/CONTRIBUTING_zh_CN.md b/CONTRIBUTING_zh_CN.md new file mode 100644 index 0000000..30dad62 --- /dev/null +++ b/CONTRIBUTING_zh_CN.md @@ -0,0 +1,64 @@ +# JustEnoughVCS 贡献指南 + +欢迎您对 JustEnoughVCS（简称 `JVCS`）项目进行贡献！在开始贡献之前，请仔细阅读本指南以确保您的贡献流程顺利。 + +## 项目结构 + +JustEnoughVCS 采用模块化架构，将核心功能与客户端工具分离为不同的代码库： + +### 核心仓库 +- **核心库**: https://github.com/JustEnoughVCS/VersionControl +- **命令行前端**: https://github.com/JustEnoughVCS/CommandLine + +## 流程 + +### 1. 准备工作 + +**对于核心库**： +- 分叉核心库到您的 GitHub 账户 +- 使用 SSH 方式克隆到本地 + +**对于前端**： +- 分叉对应的前端仓库 +- 使用 SSH 方式克隆到本地 + +### 2. 项目目录结构 + +所有前端项目都遵循统一的目录结构： + +``` +. +├── <前端名称> +│ ├── src/ # 前端源代码 +│ ├── Cargo.toml # Rust 项目配置 +│ └── README.md # 项目说明文档 +└── VersionControl/ # 核心库引用 + ├── src/ + ├── Cargo.toml + ├── CONTRIBUTING.md + ├── LICENSE-MIT.md + └── README.md +``` + +### 3. 开发环境设置 + +1. 确保已安装 Rust 工具链 +2. 克隆项目到本地 +3. 按照各仓库的 README 说明配置开发环境 + +### 4. 提交 Pull Request + +1. 在您的分叉仓库中创建功能分支 +2. 实现您的功能或修复 +3. 编写适当的测试用例 +4. 确保代码通过所有现有测试 +5. 提交清晰的提交信息 +6. 创建 Pull Request 到主仓库 + +## 注意事项 + +- 请确保您的代码遵循项目的编码规范 +- 在提交 PR 前，请同步主仓库的最新更改 +- 对于重大更改，建议先在 Issues 中讨论设计方案 + +感谢您对 JustEnoughVCS 项目的贡献！ |