153 Star 371 Fork 1.2K

openEuler / community

 / 详情

We should provide more concrete spec files for projects

待办的
任务
创建于  
2020-01-15 22:10
  • bug

We just made an investigation on all the public packages in openEuler to evaluate their formalization and stability. It seems that currently lots of spec files are not clear enough. We believe that it will bring much difficulty to fully understand the purpose of each patchset for contributors, especially for OS vendors to merge the picked patchsets.

Please let me take the project httpd for elaboration.

  1. The earliest changlog only tells us Package init

Advice: It would be better if it could show more information about the baseline version of this package and where the package comes from, community or some other distros? A specific baseline version could be helpful when dealing with dependencies. In particular, it would be very helpful if many patches are already included in this first change (e.g. lxc)

  1. There are 5 changlogs but only 4 git commits and git history seems meaningless

Advice: The changlog, with corresponding git commits is very important for contributors to know what's changed. We'd better to keep them in solid relationship and provide substantial content for both.

  1. The latest changlog only tells us delete some patches

Advice: There are also several similar messages, e.g. fix some bugs, adjust the spec, merge upstream patches, fix cves and etc.
Although we may be able to see which patches are deleted from git commit, probably we should also provide why and how to delete some patches. How about provide the ID or URL for the bug/CVE/patch?

Any feedbacks are welcome. Thanks.

评论 (8)

imjoey 创建了任务

Hey @imjoey, Welcome to openEuler Community.
All of the projects in openEuler Community are maintained by @openeuler-ci-bot.
That means the developpers can comment below every pull request or issue to trigger Bot Commands.
Please follow instructions at https://gitee.com/openeuler/community/blob/master/en/command.md to find the details.

openeuler-ci-bot 添加了
 
kind/bug
标签
imjoey 负责人设置为Fred_Li
imjoey 负责人Fred_Li 修改为未设置

Thank you for your detailed description. Yes, it is a bug that the community need handle seriously.
What should we do?
Firstly I will share this information in the mailing lists, and try to find engineers who may not be in the list.
Secondly, I will arrange kind of training for the maintainers/committers who are reviewing.

It will not be easy to improve in one day, but I will continue helping on this.

@imjoey thanks so much for the advice. that's really helpful.

Thank you for your detailed description. Yes, it is a bug that the community need handle seriously.
What should we do?
Firstly I will share this information in the mailing lists, and try to find engineers who may not be in the list.
Secondly, I will arrange kind of training for the maintainers/committers who are reviewing.

It will not be easy to improve in one day, but I will continue helping on this.

@Fred_Li thank you very much for your efforts. Yep, openEuler is a fast-growing community, my team and I will also continue to make openEuler better. :-)

imjoey 修改了标题
imjoey 修改了描述

This is a very good point to improve the current commit/push quality: we can see it is a common issue.
I suggest that a review process or a gatekeeper role should be implemented by each domain, maybe the maintainer are a good condidate. And a commit template should be set-up for everyone.
the commit template should be include the followings:
Commit summary,
Commit details,
Commit test verification.
TodoList and etc.

openeuler-ci-bot 负责人设置为myeuler
openeuler-ci-bot 移除了
 
kind/bug
标签
openeuler-ci-bot 负责人myeuler 修改为cynthia_xh
openeuler-ci-bot 负责人cynthia_xh 修改为Fred_Li
openeuler-ci-bot 负责人Fred_Li 修改为myeuler

登录 后才可以发表评论

状态
负责人
项目
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
预计工期 (小时)
参与者(6)
5329419 openeuler ci bot 1632792936 335059 imjoey 1659535604 5250947 zerodefect 1578983253 5210900 freesky edward 1578982489 5260176 yangli69393 1578983381
Go
1
https://gitee.com/openeuler/community.git
git@gitee.com:openeuler/community.git
openeuler
community
community

搜索帮助