diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..98b06761feeae7eae470246d725e97bee504c32b --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# macOS +.DS_Store + +# Editor +.vscode/ +.idea/ +*.swp +*~ + +# Diff review artifacts +changes.diff diff --git a/README.en.md b/README.en.md index 58fd9a1cba655d1952295e84dba27197d2510e8d..e094065089c2abb785775357fc1a4b2399d2bcb1 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,48 @@ # test-git #### Description -test-git + +`test-git` is a sample repository for practicing the Gitee Fork and Pull Request workflow. + +- **Fork**: https://gitee.com/hepuyao/test-git +- **Upstream**: https://gitee.com/cuos/test-git #### Software Architecture -Software architecture description + +This repository contains documentation only with no runtime dependencies: + +``` +test-git/ +├── README.md # Chinese documentation +├── README.en.md # English documentation +└── .gitignore # Ignore rules +``` #### Installation -1. xxxx -2. xxxx -3. xxxx +1. Fork the upstream repository to your Gitee account +2. Clone your fork: `git clone https://gitee.com//test-git.git` +3. Add the upstream remote: `git remote add upstream https://gitee.com/cuos/test-git.git` #### Instructions -1. xxxx -2. xxxx -3. xxxx +1. Create a feature branch locally: `git checkout -b feat/your-change` +2. Make changes and commit: `git add . && git commit -m "Describe your change"` +3. Push to your fork: `git push origin feat/your-change` +4. Open a Pull Request against the upstream repository on Gitee #### Contribution -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - +1. Fork the repository +2. Create a `feat_xxx` branch +3. Commit your code +4. Open a Pull Request to the upstream repository #### Gitee Feature -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md and Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source projects at [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md index 231e2a2eb7db34a488bfbedd5b7bfd58425af059..ae2e71a5d9b201184f1691fc8e629ccc42b495cf 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,48 @@ # test-git #### 介绍 -test-git + +`test-git` 是一个用于练习 Gitee Fork 与 Pull Request 工作流的示例仓库。 + +- **Fork 仓库**:https://gitee.com/hepuyao/test-git +- **上游仓库**:https://gitee.com/cuos/test-git #### 软件架构 -软件架构说明 +本仓库仅包含文档,无运行时依赖,结构如下: + +``` +test-git/ +├── README.md # 中文说明 +├── README.en.md # 英文说明 +└── .gitignore # 忽略规则 +``` #### 安装教程 -1. xxxx -2. xxxx -3. xxxx +1. Fork 上游仓库到你的 Gitee 账号 +2. 克隆 Fork 后的仓库:`git clone https://gitee.com//test-git.git` +3. 添加上游远程:`git remote add upstream https://gitee.com/cuos/test-git.git` #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +1. 在本地创建功能分支:`git checkout -b feat/your-change` +2. 修改代码并提交:`git add . && git commit -m "描述你的改动"` +3. 推送到 Fork 仓库:`git push origin feat/your-change` +4. 在 Gitee 上向上游仓库发起 Pull Request #### 参与贡献 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - +1. Fork 本仓库 +2. 新建 `feat_xxx` 分支 +3. 提交代码 +4. 向上游仓库新建 Pull Request #### 特技 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) + +1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md、Readme\_zh.md +2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) +3. 你可以通过 [https://gitee.com/explore](https://gitee.com/explore) 了解 Gitee 上的优秀开源项目 +4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 +5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)