Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC] Release 1.0 #195

Open
4 tasks
hyj1991 opened this issue Sep 9, 2022 · 7 comments
Open
4 tasks

[RFC] Release 1.0 #195

hyj1991 opened this issue Sep 9, 2022 · 7 comments

Comments

@hyj1991
Copy link
Member

hyj1991 commented Sep 9, 2022

背景

artus/core 目前已经累积处理了大量新 feature / 局部无破坏性重构 / 破坏性重构,beta tag 也已经发到了 26

可以考虑在近期发布 1.0 正式版,锁定 API,进一步稳定上层封装结构。

此外,新增的需求需要评估属于:

  • bug 修复
  • 兼容的局部逻辑重构
  • 兼容的新功能增加

这些部分则直接合并入 1.x 分支并同步根据 sermver 规则发布新版本

如果新增需求属于:

  • 破坏性的局部重构
  • 破坏性的新功能

此部分逻辑合并入 next 分支,作为 2.x 更新特性

最后,next 分支代码需要定期和 master 进行 rebase,以便将 1.x 中的 bug 修复 / 兼容变更一并合入

步骤

  • 使用文档
  • 代码注释完善
  • 单测完善
  • Release 1.0
@hyj1991 hyj1991 self-assigned this Sep 9, 2022
@whxaxes
Copy link
Member

whxaxes commented Sep 9, 2022

1.0 发布之前文档是不是也需要准备好?

@atian25
Copy link
Member

atian25 commented Sep 9, 2022

先把每个库的注释都补了吧,至少所有的 public 的属性和方法,都要有 jsdoc 描述

@noahziheng
Copy link
Member

  • 文档
  • 注释
  • 单测覆盖率

@hyj1991
Copy link
Member Author

hyj1991 commented Sep 9, 2022

这些需要加上

@hyj1991
Copy link
Member Author

hyj1991 commented Sep 9, 2022

可以作为 Release 1.0 的子项推进,集中社区的力量在 文档 / 注释 / 覆盖率上,新的 feature 或者 break 重构优先级降低

@hyj1991 hyj1991 removed their assignment Sep 9, 2022
@hyj1991
Copy link
Member Author

hyj1991 commented Oct 11, 2022

cc @noahziheng cc @DuanPengfei cc @atian25 ,1.0 是否可以先发布出来,后续的迭代我们把 minor / patch 特性做到 1.x 里面,break 的优化 / 新功能做到 next 分支里面

尽早发 1.0 的一个好处是后面可以收敛 break 重构 / 更新

@fengmk2
Copy link
Member

fengmk2 commented Oct 19, 2022

定一个发布时间?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants