参与本项目

⚡ 前言

欢迎来到我们的项目!本项目旨在建立一个基于区块链的全民学习平台,通过集体的智慧和努力,推动技术和知识的普及。无论您是初学者还是经验丰富的开发者,您的贡献都将对项目产生积极影响。

💡 关于本项目(先看❗)

本项目由一个热衷于区块链和软件开发的团队发起。我们致力于创建一个开源、去中心化的学习环境,让每个人都能够访问和分享知识。

🌐 联系方式

🔍 项目背景

我们相信,通过集体智慧和技术的力量,可以打造一个更加开放和包容的学习环境。这个项目不仅是一个技术挑战,也是社区合作的成果。

🌟 如何参与

不论您的技能水平如何,都有多种方式可以参与本项目:

  • 提交问题和功能建议。
  • 参与代码编写和文档撰写。
  • 在社区中提供帮助和支持。

我们都是这个仓库未来很有潜力的客户,或者是贡献者,谢谢你选择了加入C-UB社区,我们将会一起合作,未来我们将会考虑以区块链为底层搭建一个全民学习平台,我们每一个人都将会是这个社区的构建着,将会推动c-universal blockchain(链学) 社区的发展和进步~

  1. 如果你对本项目有任何建议或发现文中内容有误的,欢迎提交 issues 进行指正。
  2. 对于文中我没有涉及到知识点,欢迎提交 PR。

或许我们会很疑惑?

在我们参与贡献的时候,如果克隆了**🧷 cs-awesome-Block_Chain项目,但是每次获取上游代码很麻烦怎么办?如何提交有意思的代码?这篇文章将会解决这个问题~⬇️ **

⚡提前需要你…

排版

笔记内容按照 中文文案排版指北 进行排版,以保证内容的可读性。

不使用 ![]() 这种方式来引用图片,而是用 <img> 标签。一方面是为了能够控制图片以合适的大小显示,另一方面是因为 GFM 不支持 <center> ![]() </center> 这种方法让图片居中显示,只能使用 <div align="center"> <img src=""/> </div> 达到居中的效果。

谷歌代码规范

🧷 谷歌代码规范可以说是公认的规范,也是目前大多数企业都以为标准~

对于大型程序,我们需要对 🔥软件工程有一定的了解

协议许可

所有内容遵循CC-BY-SA 3.0协议(署名-相同方式共享)©

⚡贡献步骤

我们的fork,如何保证实时的同步上游?🧷这篇教会你 保持自己github的forks自动和上游仓库同步并推送到 gitee

📮 你甚至可以通过 🧷GitHub 的actions ci/cd 玩出更多花样~

💡 步骤

  1. 首先在Githubfork本仓库到你的仓库
  2. git clone克隆到本地
  3. 在本地修改对应的代码
  4. git push到自己的仓库
  5. 在自己的仓库进行pull request的操作

Github会首先比较你仓库中的项目与目的项目的区别,并且会检查这两者之间是否可以进行合并操作

等了一会之后,Github提示Able to merge可以进行合并后,你就可以点击Create pull request了。

这里会让你填一个对你修改代码的一个说明,然后就可以真正的创建一个pull request了(点击这个Create pull request按钮)

⚡你还可以

  1. 重新创建一个分支

  2. 分支下面修改

  3. 提交代码

⚡ 如果你是在CubDoc文档中

⚠️ 例如:你是在以下的文档中~

⬇️ 那么你就更容易了,你可以选择下面两种方法:

直接修改,上传

image-20221015232042494

⬇️ 继续在GitHub中直接修改md文件,然后提交:

image-20221015232445350

clone到本地修改

  1. 首先fork文档所所在仓库地址到自己的仓库(查看源码)
  2. clone刚刚fork到自己账户的仓库
  3. 在本地进行修改,记住经常pull上游的代码
  4. 提交本地的代码到自己的仓库
  5. 将自己的仓库贡献到我们的仓库

📜 对上面的解释

我们需要经常pull保持分支所在最新,可以看🧷这篇教会你 保持自己github的forks自动和上游仓库同步并推送到 gitee

将自己的仓库贡献到我们的仓库只需要:

image-20221015233657581

我们希望什么样的request?

优化已有代码或者文档

  1. 补充和分享项目笔记
  2. 修改错误的代码
  3. 给看不懂的地方一些补充和说明

提醒⚠️

push代码之前 一定要 先pull最新代码,否则提交的pr可能会有删除其他push的操作。

一个pr 不要修改过多文件,因为一旦有一个 文件修改有问题,就不能合入,影响其他文件的合入了。

git add之前,要git diff 查看一下,本次提交所修改的代码是不是 自己修改的,是否 误删,或者误加的文件。

提交代码,不要使用git push -f (或者是--force )这种命令,要足够了解 -f 强制提交覆盖远程意味着什么。

不用非要写出牛逼的代码才能提交PR,只要发现文章中有任何问题,或者错别字,都欢迎提交PR,成为contributor

commit 时要注意 commit 的信息要符合规范。然后 push 上来,最后提交一个 pull request。