开源项目开始准备

时间 2019-11-12

标签开源项目开始准备繁體版

原文原文链接

肯定是 `组织` 仍是`项目`

组织：Facebook是一个组织帐户，下面有许多项目。帐号名称为组织帐号。官网名称为：facebook.github.io/react
项目：专门针对一个产品，这个帐号下面就一个主产品，其它产品都是它的产品等分支。帐号名称使用项目名称便可。官网名称为：rollup.github.io

注册帐号

建立项目

安装git

下载git安装包直接安装
打开Git Bash命令框html

设置用户，用户名和密码都设置为GitHub的
git config --global user.name "Your Name"
git config --global user.email "email@example.com"

win建立SSH KEY

查看是否有SSH key
cat ~/.ssh/id_rsa.pub
若是不存在则建立
ssh-keygen -t rsa -C "171250669@qq.com"
建立后查看
cat ~/.ssh/id_rsa.pub
复制到剪贴板
clip < ~/.ssh/id_rsa.pub

将GitHub项目克隆到本地

进入要放置的文件
git clone git@github.com:Firsmant/info-manage.git

提交代码

进入本地项目目录
添加文件：git add .
提交到本地：git commit -m "first update"
将本地代码同步到服务器：git push origin master

搭建开发环境

版本说明

版本号分三级
0.x.x能够认为是非正式版本、测试版本
从1.x.x开始正式发布版本
"version":"0.0.1"node

一级：重构版本
二级：重大功能改进
三级：小升级或者bug修复

规范项目一级目录

src - 源码
release- 发布结果
test- 单元测试用例
doc- 文档
example - 示例

初始化

进入项目目录运行 npm init按提示完成，参考package.json文件填写相应内容。注意版本号和license不能默认，入口js修改成src/index.jsreact
生成package.json文件
webpack

构建工具

使用 webpackgit

安装npm i babel-core babel-loader babel-polyfill babel-preset-es2015 babel-preset-latest webpack webpack-cli --save-dev
后面再加上淘宝镜像
--registry=https://registry.npm.taobao.orggithub
在项目更目录下建立.babelrc文件，添加内容

{ 
    "presets": ["es2015", "latest"],
    "plugins": [] 
}

在项目根目录下建立webpack.config.js文件，添加内容以下
将entry文件发布到output

module.exports = { 
    entry: './src/index.js',
    output: { path: __dirname,
        filename: './release/bundle.js' 
            },
    module: { 
        rules: [{ 
            test: /\.js?$/,
             exclude: /(node_modules)/, 
             loader: 'babel-loader' 
            }] 
    }
}

修改package.json中的scripts，添加"release":"webpack"，说明使用的打包工具

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "release": "webpack"
  },

运行npm run release生成release内容
在example文件夹中新增test.html文件，添加内容

<!DOCTYPE html>
 <html>
  <head> 
    <meta charset="UTF-8"> 
    <title>example</title> 
  </head> 
  <body>
    <p>example</p>

    <script src="../release/bundle.js"></script>
   </body> 
</html>

修改package.json中的scripts增长"example":"http-server -p 8880"

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "release": "webpack",
    "example": "http-server -p 8880"
  },

安装服务器建立工具，运行npm install http-sever -g
将服务跑起来，运行npm run example

浏览器访问localhost:8880/example/test.html

完善README.md

产品简介
产品安装和下载
快速使用（详细文档能够外链）
交流提问区
关于做者（放置博客连接和收款二维码）

写文档 & 写测试用例

测试用例须要用到其它工具web

写文档

经过md格式生成文档，安装工具，npm install gitbook-cli -g
根目录下建立SUMMARY.md，内容以下：

# Summary

* [项目介绍](README.md)
* [使用文档](doc/use/README.md)
    * [使用1](doc/use/use1.md)
    * [使用2](doc/use/use2.md)
* [二次开发](doc/dev/README.md)
    * [开发1](doc/dev/dev1.md)
    * [开发2](doc/dev/dev2.md)

执行npm install gitbook -g安装工具
执行gitbook init 按照以上目录在doc中建立文件

执行 gitbook build将md文件发布为html文件
在http://localhost:8880/_book/中查看

提交代码

使用 es-lint规范编码npm

提交代码版本v0.0.1

建立tag并提交

git tag -a 'v0.0.1' -m 'first commit'
git push origin v0.0.1

能够在https://github.com/Firsmant/info-manage/releases进行查看

提交到npm

可让用户经过npm进行安装json

运行npm adduser注册帐户
npm login登陆用户
项目根目录下执行npm publish .发布到npm

代码升级

建立分支 git checkout -b dev，在分支中进行修改
在package.js中修改版本号,而后提交修改
git add .
git commit -m "0.0.2"
git push origin dev
进入master分支git checkout master
将dev合并到mastergit merge div
提交mastergit push origin master
建立tag并提交到远程
提交到npm

合并pr

建立官网

在GitHub上建立项目github用户名.github.io名称规则是这样的
在根目录下建立index.html
直接访问github用户名.github.io便可
若是是组织帐户，能够把子帐户打包的_book内容复制到组织帐户的根目录下

转载连接：https://www.imooc.com/article/28240浏览器

开源项目开始准备

肯定是 组织 仍是项目

注册帐号

建立项目

安装git

win建立SSH KEY

将GitHub项目克隆到本地

提交代码

搭建开发环境

版本说明

规范项目一级目录

初始化

构建工具

完善README.md

写文档 & 写测试用例

写文档

提交代码

提交代码版本v0.0.1

提交到npm

代码升级

合并pr

建立官网

肯定是 `组织` 仍是`项目`