Demo 项目

软件工程实验一：开发环境搭建与版本控制入门

---

项目概述 (What)

本项目是头歌实践教学平台上的 Git 版本控制实验仓库，用于存放《第1次实验-工欲善其事——开发环境搭建与版本控制入门》的实验报告、相关配置与操作记录，完成从本地仓库搭建到远程仓库同步的完整流程。

---

设计思路 (Why)

• 遵循 Git 标准目录结构规范，清晰区分代码、文档、测试等内容，便于项目维护与版本管理
• 以实验报告为核心，完整记录 VSCode 配置、Git 操作全流程，满足课程作业要求
• 规范 README.md 文档，为项目提供完整说明，方便后续实验内容的迭代与追溯

---

实现方式 (How)

1. 项目目录结构

文件/目录	描述	用途
/src	源代码目录	存放项目的源代码（本次实验暂未使用，预留后续开发）
/docs	文档目录	包含项目的文档和使用手册（本次实验存放实验相关参考资料）
/tests	测试目录	存放测试脚本和测试数据（本次实验暂未使用，预留后续测试）
README.md	项目说明文件	提供项目的基本信息和使用指南
report1.md	实验报告文件	存放实验一完整报告，包含操作步骤、截图、问题与总结
.gitignore	Git 忽略文件	配置无需提交到仓库的文件/目录
LICENSE	开源协议文件	声明项目开源协议

2. 核心操作流程

1. VSCode 环境配置：安装 Markdown All in One、Draw.io Integration、GitLens 等插件，配置字体大小、自动保存等参数
2. Git 仓库操作：
   • 克隆头歌远程仓库到本地
   • 配置 Git 用户名、邮箱等用户信息
   • 编写实验报告 report1.md，通过 git add/git commit/git push 提交到远程仓库
3. Markdown 文档编写：使用 Markdown 语法完成结构化实验报告，插入操作截图，完成作业要求

---

项目内容

• report1.md：实验一完整报告，包含：
  • VSCode 安装与插件配置
  • Git 仓库创建、克隆、提交、推送全流程
  • 操作截图、问题解决、实验总结
• .gitignore：Git 忽略规则配置
• LICENSE：Apache-2.0 开源协议

---

使用说明

1. 环境要求

   • 操作系统：Windows 11 / macOS / Linux
   • 开发工具：Visual Studio Code
   • 版本控制：Git (v2.53.0+)
   • 远程仓库：头歌实践教学平台 Git 仓库

2. 本地操作步骤

   # 1. 克隆远程仓库
   git clone https://bdgit.educoder.net/px69why5e/Demo.git
   
   # 2. 进入项目目录
   cd Demo
   
   # 3. 配置 Git 用户信息（首次使用）
   git config --global user.name "邓秀蕊"
   git config --global user.email "你的邮箱@xxx.com"
   
   # 4. 编写/修改实验报告后，提交到本地仓库
   git add .
   git commit -m "更新实验报告内容"
   
   # 5. 推送到远程仓库
   git push origin main
   

---

版本历史 (Change Log)

版本	日期	修改人	修改内容
V1.0	2026-04-07	邓秀蕊	初始版本创建，完成实验一报告编写与仓库搭建
V1.1	2026-04-07	邓秀蕊	完善 README.md 项目说明，补充目录结构与操作流程

---

作者信息

• 作者：邓秀蕊
• 项目仓库：https://bdgit.educoder.net/px69why5e/Demo.git
• 所属课程：软件工程2026春季班级

---

许可证

本项目采用 Apache-2.0 开源协议