libin 7 months ago
parent
commit
e6744fbd51
2 changed files with 32 additions and 27 deletions
  1. 32 0
      readme.md
  2. 0 27
      readme.txt

+ 32 - 0
readme.md

@@ -0,0 +1,32 @@
+MiniProjectX 项目贡献指南
+
+欢迎来到 MiniProjectX 代码仓库!我们鼓励您分享您的代码小项目,以促进知识的交流和社区的活跃。在贡献您的代码之前,请仔细阅读以下指南,以确保贡献过程顺利无阻。
+
+### 贡献步骤
+
+1. **克隆仓库**: 将项目克隆到本地计算机。
+   ```
+   git clone https://git.itopmap.com:300/iTopmap/MiniProjectX.git
+   ```
+
+2. **创建您的目录**: 在仓库的根目录下创建一个新的目录,以您的用户名或项目名称命名。
+   ```
+   mkdir newproject
+   ```
+
+3. **编写代码**: 在新的目录下编写您的代码。请确保您的代码符合以下要求:
+   - 不要删除或修改其他人的目录或代码
+   - 使用合理的变量名和注释,以便他人理解
+
+4. **提交和推送**: 将您的更改提交并推送到仓库。
+   ```
+   git add .
+   git commit -m "提交信息"
+   git push origin master
+   ```
+
+### 代码规范
+
+- **编码风格**: 请遵循一致的编码风格。
+- **文件结构**: 保持清晰的文件和目录结构。
+- **文档**: 添加必要的注释和文档字符串,以便他人理解您的代码。

+ 0 - 27
readme.txt

@@ -1,27 +0,0 @@
-MiniProjectX 项目贡献指南
-欢迎来到MiniProjectX代码仓库!我们鼓励您分享您的代码小项目,以促进知识的交流和社区的活跃。在贡献您的代码之前,请仔细阅读以下指南,以确保贡献过程顺利无阻。
-
-贡献步骤
-克隆仓库
-将项目克隆到本地计算机。
-	git clone https://git.itopmap.com:300/iTopmap/MiniProjectX.git
-
-创建您的目录
-在仓库的根目录下创建一个新的目录,以您的用户名或项目名称命名。
-	mkdir newproject
-
-编写代码
-在新的目录下编写您的代码。请确保您的代码符合以下要求:
-	- 不要删除或修改其他人的目录或代码
-	- 使用合理的变量名和注释,以便他人理解
-
-提交和推送
-将您的更改提交并推送到仓库。
-	git add .
-	git commit -m "提交信息"
-	git push origin master
-
-代码规范
-- 编码风格: 请遵循一致的编码风格。
-- 文件结构: 保持清晰的文件和目录结构。
-- 文档: 添加必要的注释和文档字符串,以便他人理解您的代码。