开源软件
- 源码
- 文档(二次开发文档+用户使用文档)
- 开发环境:告诉二次开发者如何搭建及运行代码
- 允许他人贡献代码(不仅仅给他人阅读源码的权限)
- 问题(用户提问,维护者答复,问题共享而非私聊)
- 问题列表和升级计划(记录当前问题及何时解决、何时升级)
其他配套设施
- 官网
- 文档(可以和官网整合在一起)
- 问答社区(eg. GitHub的issue)
- 及时交流社区(群组,eg. 微信群等)
本文记录制作一个cache工具的过程(命名为fast-cache)
注册账号
开源软件
- 源码
- 文档(二次开发文档+用户使用文档)
- 开发环境:告诉二次开发者如何搭建及运行代码
- 允许他人贡献代码(不仅仅给他人阅读源码的权限)
- 问题(用户提问,维护者答复,问题共享而非私聊)
- 问题列表和升级计划(记录当前问题及何时解决、何时升级)
其他配套设施
- 官网
- 文档(可以和官网整合在一起)
- 问答社区(eg. GitHub的issue)
- 及时交流社区(群组,eg. 微信群等)
本文记录制作一个cache工具的过程(命名为fast-cache)
注册账号
新建仓库
- 选择
Public - 选择
Initialize this repository with a README生成初始化的reademe文件 Add.gitignore选项可以选择提交的时候要忽略的文件Add a license处选择MIT
创建仓库完成后可以通过https://github.com/github用户名/仓库名访问到项目主页。
添加ssh key
ssh key是连接电脑和GitHub服务器的钥匙,只有添加成功才能将本地代码提交到GitHub服务器
- 右上角个人中心->settings->SSH and GPG keys->new SSH key
视频课中讲解了如何在ios系统添加ssh key 本文介绍Windows系统中ssh key 的添加方法
Windows系统中ssh key 的添加方法
需要先下载安装git(Mac环境中自带git无需安装)
- 首次配置需要设置git的
username和email
git config --global user.name "your username"
git config --global user.email "your email"
2. 检查ssh key是否存在
cd ~/.ssh
ls
# 或者
ll
# 查看是否存在 id_rsa 和 id_rsa.pub文件,如果存在,说明已经有SSH Key
- 如果没有ssh key
# 生成ssh key
ssh-keygen -t rsa -C "your emial"
# 执行完之后再次查看ssh key 是否存在
4. 获取ssh key
cat id_rsa.pub
# 获取秘钥 复制ssh-rsa开头的一段秘钥
5. 将复制的内容粘贴至下方红色框中,对该ssh key 进行命名填入
Title栏并点击Add SSH key即可
- 将远程项目克隆到本地文件夹
点击
<>Code选择SSH并复制链接-->在powershell窗口进行git clone 链接的操作可以将远程仓库克隆至本地
- 验证
ssh key是否生效
# 在本地打开README.md文件修改后保存并提交,查看是否提交成功
# 提交步骤如下
git add . # 将所有修改完成后的内容添加暂存区
git commit -m "提交说明" # 书写提交说明,可以写这次修改了什么
git push origin master # 将暂存区的内容提交到master分支 git push表示提交到main分支
下图即为提交成功