红满堂工作室技术组新人注意事项

鉴于技术组新人进来之后都好像会蒙逼几天,特意写这篇文章来解决这个尴尬的状况(有点仓促,写得不太好).

注意事项:

1.注册下面三个工具,并告诉你们的项目负责人你们的账号.

2.进去堂聊之后记得加入你们所属项目的频道.

3.不要使用微信谈项目的东西!不要使用微信谈项目的东西!不要使用微信谈项目的东西!

4.要使用堂聊谈项目的东西!要使用堂聊谈项目的东西!要使用堂聊谈项目的东西!

5.新开的项目必须要由项目负责人开个项目开始会议(地点在工作室).

一.聊天工具 —- 堂聊

使用说明链接:堂聊使用说明

二.任务管理平台 —- teambition

使用说明链接:teambition使用规范

三.代码托管平台 —- hgit

使用说明链接:hgit使用指南, git使用规范流程(转)

四.红满堂开发规范

1.红满堂前端开发规范

2.红满堂后端开发规范(暂无)

3.红满堂数据库开发规范

 

待补充…

Git 使用规范流程(转自阮一峰)

Git 使用规范流程

作者: 阮一峰

日期: 2015年8月 5日

团队开发中,遵循一个合理、清晰的Git使用流程,是非常重要的。

否则,每个人都提交一堆杂乱无章的commit,项目很快就会变得难以协调和维护。

下面是ThoughtBot 的Git使用规范流程。我从中学到了很多,推荐你也这样使用Git。

第一步:新建分支

首先,每次开发新功能,都应该新建一个单独的分支(这方面可以参考《Git分支管理策略》)。

第二步:提交分支commit

分支修改后,就可以提交commit了。

git add 命令的all参数,表示保存所有变化(包括新建、修改和删除)。从Git 2.0开始,all是 git add 的默认参数,所以也可以用 git add . 代替。

git status 命令,用来查看发生变动的文件。

git commit 命令的verbose参数,会列出 diff 的结果。

第三步:撰写提交信息

提交commit时,必须给出完整扼要的提交信息,下面是一个范本。

第一行是不超过50个字的提要,然后空一行,罗列出改动原因、主要变动、以及需要注意的问题。最后,提供对应的网址(比如Bug ticket)。

第四步:与主干同步

分支的开发过程中,要经常与主干保持同步。

第五步:合并commit

分支开发完成后,很可能有一堆commit,但是合并到主干的时候,往往希望只有一个(或最多两三个)commit,这样不仅清晰,也容易管理。

那么,怎样才能将多个commit合并呢?这就要用到 git rebase 命令。

git rebase命令的i参数表示互动(interactive),这时git会打开一个互动界面,进行下一步操作。

下面采用Tute Costa的例子,来解释怎么合并commit。

上面的互动界面,先列出当前分支最新的4个commit(越下面越新)。每个commit前面有一个操作命令,默认是pick,表示该行commit被选中,要进行rebase操作。

4个commit的下面是一大堆注释,列出可以使用的命令。

  • pick:正常选中
  • reword:选中,并且修改提交信息;
  • edit:选中,rebase时会暂停,允许你修改这个commit(参考这里
  • squash:选中,会将当前commit与上一个commit合并
  • fixup:与squash相同,但不会保存当前commit的提交信息
  • exec:执行其他shell命令

上面这6个命令当中,squash和fixup可以用来合并commit。先把需要合并的commit前面的动词,改成squash(或者s)。

这样一改,执行后,当前分支只会剩下两个commit。第二行和第三行的commit,都会合并到第一行的commit。提交信息会同时包含,这三个commit的提交信息。

如果将第三行的squash命令改成fixup命令。

运行结果相同,还是会生成两个commit,第二行和第三行的commit,都合并到第一行的commit。但是,新的提交信息里面,第三行commit的提交信息,会被注释掉。

Pony Foo提出另外一种合并commit的简便方法,就是先撤销过去5个commit,然后再建一个新的。

squash和fixup命令,还可以当作命令行参数使用,自动合并commit。

这个用法请参考这篇文章,这里就不解释了。

第六步:推送到远程仓库

合并commit后,就可以推送当前分支到远程仓库了。

git push命令要加上force参数,因为rebase以后,分支历史改变了,跟远程分支不一定兼容,有可能要强行推送(参见这里)。

第七步:发出Pull Request

提交到远程仓库以后,就可以发出 Pull Request 到master分支,然后请求别人进行代码review,确认可以合并到master。

(完)

Teambition使用规范

为了开发效率,以及方便管理项目的进度和详情,熟悉运用teambition是红满堂工作室技术开发必不可少的工具之一,所以定了以下相关条例来规范teambition的使用。

一、人员管理

  • 参与开发的项目小组成员必须拥有teambition账号并加入到这个项目来。
  • 邀请新成员时,除了项目小组成员,还有现任管理层技术人员和boss。
  • 每个项目小组必须有一个负责人,把控整个项目的进度和流程。
  • 每个项目小组必须有一个测试人员,负责任务的完成质量。

二、任务分配

  • 添加任务时,应清晰描述任务的内容,如果有图片文字相关资料可以添加到具体任务的附件里。
  • 对问题描述不清晰的,应直接与任务添加人沟通
  • 小组负责人有权利直接分配任务给成员,成员在无人领取的任务里挑选.
  • 小组负责人把控时间进度,根据任务难度设置截止日期,分配时间。遇到时间分配不合理的情况,组员之间相互协调沟通解决。
  • 如果有紧急的任务,例如比较严重的bug(已经影响大量用户使用的bug),可以设定任务优先级。
  • 合理设置任务结构,项目模块可以建一个大任务,下分小任务。

三、任务处理

  • 合理设置任务列表,建议列表分为:待处理(需求、bug),进行中,完成待测试,测试通过、已完成。5个列表左右较为合适,可以根据自己的项目进行调节。但测试环节不能少。
  • 领取任务时,改执行者后,把任务拖拽到进行中,让小组成员知道你的工作状态和具体任务。
  • 完成任务就拖拽到测试的列表,待测试。
  • 测试不通过的在任务下方留言具体的原因,并把任务直接拖拽回进行中,继续处理。
  • 完成测试,应该用文档周期性记录已完成的任务。

四、任务总结

由已完成列表的任务情况,每周定期记录一周的任务分配以及完成情况,哪个小组成员做了什么,完成度如何。

红满堂数据库开发规范

一.建库规范

1.建库都要加上数据库注释,表注释,字段注释.如果字段只有几个值的话,字段注释要写清楚每一个值对应的注释.

2.数据库,表,字段命名用”_”下划线分割单词,不能使用中文或者拼音命名,统一用单词小写.

3.新建的表如果是记录表,那么必须要有id,status,updated_at,deleted_at,created_at:

(1)id:记录该记录递增的id

(2)status:该记录的状态,通常(一般来说)值意义为:0(不启用),1(启用)

(3)updated_at:该记录的更新时间

(4)deleted_at:软删除字段

(5)created_at:该记录的创建时间

4.建表,建字段的时候要考虑以后应用扩展的问题,不要建无用表,无用字段,能用其他表联合查询或者关联查询的就不必要建多一个表或者字段.

5.建字段的时候一定要搞清楚字段属性的作用.不要随便建字段.每个字段对应的各种属性(比如A.I.还有类型如tinyint)都要搞懂,看满不满足字段的需求.不懂的可以问或者google百度.

 

二.数据库维护

 

三.数据库扩展

 

数据库开发规范 V 0.10 版,有待完善

WEB IDE 简单使用说明

应用地址:http://192.168.249.82

技术说明

  1. 平台使用技术:python3,docker,开源ide项目
  2. web框架:bottle
  3. 数据库存储:redis
  4. http服务器:nginx

IDE选择

  1. codebox是可以编辑代码的,附加有命令行功能。
  2. tty.js仅仅提供一个web控制台功能。

账号说明

  1. 每一个IDE背后都运行在一个独立的系统,暂时是centos6。
  2. 每个系统用户名和密码都是在控制台显示那个,自己修改了我们就无法帮你找回。
  3. 每个系统root密码也是你控制台显示那一个随机密码

如果您在使用过程中遇到任何问题或者想反馈意见,请在文章后面留言。