From c4d1ad91a84e35377996cc9aaa055daa1b329ff7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=AE=B8=E8=BD=B2?= Date: Sun, 20 Aug 2023 02:35:41 +0800 Subject: [PATCH] init --- .gitignore | 1 + README.md | 2 +- zh-cn/{readme.md => a_doc.md} | 3 +- zh-cn/new.md | 99 +++++++++++++++++++++++++++++++++++ 4 files changed, 103 insertions(+), 2 deletions(-) create mode 100644 .gitignore rename zh-cn/{readme.md => a_doc.md} (91%) create mode 100644 zh-cn/new.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..85e7c1d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.idea/ diff --git a/README.md b/README.md index da8cc0b..975dc55 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,4 @@ ## 文档目录结构 -[中文文档](zh-cn/readme.md) \ No newline at end of file +[中文文档](zh-cn/a_doc.md) \ No newline at end of file diff --git a/zh-cn/readme.md b/zh-cn/a_doc.md similarity index 91% rename from zh-cn/readme.md rename to zh-cn/a_doc.md index 5feb4bd..30bd65c 100644 --- a/zh-cn/readme.md +++ b/zh-cn/a_doc.md @@ -1,3 +1,4 @@ # JCNC开发者文档 -本目录是JCNC开发者文档的中文目录。目录内容包括: \ No newline at end of file +本目录是JCNC开发者文档的中文目录。目录内容包括: + diff --git a/zh-cn/new.md b/zh-cn/new.md new file mode 100644 index 0000000..b969c1a --- /dev/null +++ b/zh-cn/new.md @@ -0,0 +1,99 @@ +# 新人参与开源项目指南 + + +## 1. 什么是开源? + +开源项目是指软件或项目的源代码是公开的,任何人都可以查看、使用、修改和分发。开源的核心价值在于协作、透明和知识共享,这种开放的方式推动了技术的创新和进步。 + +## 2. 开源项目的基本概念 + +在开始之前,了解一些基本概念将非常有帮助: + +* 版本控制系统(如Git): 版本控制允许你跟踪代码的变化,方便协作和恢复历史状态。 +* 代码仓库: 这是存储项目代码的地方,通常位于GitHub、Gitee、GitLab等平台上。 +* 分支: 分支是在代码仓库上进行独立开发的方式,它允许你在不影响主要代码的情况下进行实验和修改。 +* 提交: 提交是对代码所做更改的快照,它包含有关更改内容的说明。 +* 拉取请求(Pull Request): 这是将你的更改合并到主代码库的方式,维护者和其他贡献者可以审查并提供反馈。 + +## 3. 选择一个适合的开源项目 + +在参与开源项目之前,考虑以下几个标准来选择合适的项目: + +* 兴趣领域: 选择你感兴趣的项目,这将激发你的动力。 +* 项目活跃度: 选择一个活跃的项目,这意味着更多的合作机会和反馈。 +* 社区支持: 寻找一个友好和包容的社区,可以帮助你更好地融入。 + +## 4. 准备工作 + +在开始贡献之前,进行一些准备工作: +* 安装Git: 学习如何安装和配置Git,以便你可以管理代码。 +* 设置开发环境: 安装所需的依赖项和开发工具,确保你可以顺利开展工作。 + +## 5. 了解项目 + +在深入投入之前,了解项目是很重要的: + +* 阅读代码: 查看项目的代码,了解项目的结构和组织。 +* 查看文档: 阅读项目的文档,理解功能、架构和设计决策。 + +## 6. 贡献流程 + +参与开源项目的流程通常包括以下步骤: + +* 克隆仓库: 使用Git克隆项目仓库到本地。 +* 创建分支: 基于主分支创建自己的分支,以便进行更改。 +* 进行修改: 进行你的更改,保持提交小而有针对性。 +* 提交代码: 提交你的更改,写清楚提交信息,解释你所做的事情。 +* 创建拉取请求: 将你的更改提交到主仓库,请求审查和合并。 + +## 7. 与社区互动 + +与社区保持积极互动: + +* 提问技巧: 学习如何恰当地提出问题,确保得到有效的帮助。 +* 参与讨论: 在问题跟踪、论坛等地方参与讨论,分享你的见解。 + +## 8. 贡献的不同方式 + +开源不仅仅是编码: + +* 文档贡献: 帮助编写和改进文档,使项目更易于理解。 +* 翻译: 将项目文档翻译成其他语言,扩大项目受众。 +* 设计和界面: 为项目添加美观和易用性。 +* 测试: 帮助测试项目,确保其质量。 + +## 9. 解决问题和冲突 + +在合作中遇到问题是正常的,学会妥善处理: +* 自学解决问题: 尝试自己找到解决方案,提升你的技能。 +* 与他人合作: 如果遇到难题,与社区成员一起合作解决。 + +## 10. 持续学习和发展 + +开源是一个不断学习的过程: +* 学习资源: 利用在线教程、文档、书籍等提升技能。 +* 持续改进: 不断反思,寻找提升贡献和合作的方法。 + +## 11. 分享你的经验 + +通过分享你的开源经验,激励其他新人参与: +* 写博客: 记录你的学习和贡献经历,分享给他人。 +* 演讲和讲座: 在技术活动上分享你的开源旅程。 + +## 12. 法律和道德注意事项 + +遵守开源项目的许可证要求和行为准则: +* 知识产权: 尊重项目的许可证和知识产权。 +* 尊重行为准则: 与社区成员互动时,遵循友好和尊重的原则。 + +## 13. 常见陷阱和建议 + +在旅程中可能会遇到一些常见问题: +* 过度承诺: 不要过于承诺,以免无法完成。 +* 畏缩不前: 不要害怕提问和尝试,积极参与。 + +## 14. 鼓励和支持 + +最重要的是,鼓励和支持你的努力: +* 参与乐趣: 记住你是为了学习和乐趣而参与,不必过于压力。 +* 成就感: 每一次贡献都是一个值得庆祝的成就,不管大小。