《代码整洁之道》中文翻译项目常见问题解决方案

《代码整洁之道》中文翻译项目常见问题解决方案

Clean-Code-zh 《代码整洁之道》中文翻译 项目地址: https://gitcode.com/gh_mirrors/cl/Clean-Code-zh

1. 项目基础介绍及主要编程语言

本项目是基于vuepress开发的《代码整洁之道》中文翻译项目，目的是为了提供一个比GitHub Markdown更佳的阅读体验。该项目主要使用了以下编程语言和技术：

• Node.js：作为服务器端的JavaScript执行环境。
• Yarn：作为包管理工具，用于管理项目依赖。
• VuePress：基于Vue的静态站点生成器，用于构建和展示文档。

2. 新手在使用这个项目时需特别注意的3个问题及解决步骤

问题一：如何本地开发项目

问题描述：新手可能不清楚如何在自己的计算机上搭建和运行这个项目。

解决步骤：

1. 确保你的计算机上已经安装了Node.js和Yarn。
2. 克隆项目到本地：git clone https://github.com/gdut-yy/Clean-Code-zh.git
3. 进入项目目录：cd Clean-Code-zh/
4. 安装项目依赖：yarn install
5. 启动本地开发服务器：yarn docs:dev
6. 在浏览器中打开http://localhost:8080/doc-cleancode/查看文档。

问题二：如何构建项目为静态文件

问题描述：新手可能不知道如何将项目构建成可以部署到服务器的静态文件。

解决步骤：

1. 在项目目录中，运行构建命令：yarn docs:build
2. 构建完成后，会在项目根目录生成一个docs文件夹，里面包含了所有静态文件。
3. 将这个docs文件夹部署到你的服务器上。

问题三：如何贡献代码或翻译

问题描述：新手可能不知道如何参与到项目的代码贡献或翻译工作。

解决步骤：

1. 阅读项目README文件，了解项目的基本信息和贡献指南。
2. Fork项目到自己的GitHub仓库。
3. 克隆自己的Fork仓库到本地，进行修改。
4. 在本地完成修改后，提交到自己的Fork仓库，并创建一个Pull Request请求。
5. 等待项目维护者审核你的Pull Request。

以上是针对《代码整洁之道》中文翻译项目的一些常见问题及其解决步骤，希望对新手有所帮助。

Clean-Code-zh 《代码整洁之道》中文翻译 项目地址: https://gitcode.com/gh_mirrors/cl/Clean-Code-zh