Hey guys,
I found out DolphinScheduler main repo
https://github.com/apache/dolphinscheduler
<https://github.com/apache/dolphinscheduler>
git flow and git commit message could be optimized,
———
1、Git flow optimized: Currently when we develop huge features, we create new
branch and
all our developers commit to the new branch, just like
https://github.com/apache/dolphinscheduler/pull/6124
<https://github.com/apache/dolphinscheduler/pull/6124>.
This git flow have some dark spot
1) When new branch merging to dev branch, there are many conflict and cost PR
creator many time to solve it
2) When new branch merge to dev branch, we have to use “merge" rather than
"squash merge” to keep
other developer commit history. If new branch have tmp commit, such as “fix
ci” or “correct code style”,
if would commit exactly a commit to dev branch but we donot want
3) Community tracking problem. When we develop in new branch, our community
could not know feature progress rate
unless it merged to dev branch(most of developer only track dev branch).
This means only few user/developer
could know or join our new features, and that not good for our community
I proposal we create DSIP(just like SPIP[1] or FLIP[2]) for our huge
feature/improvement, which make our process open
to all our users and developers. Beside we could use github issue task[3] or
some else to track related PR(of cause we should
separate our PR if it more than one), it could be useful for any relevant
followup/future enhancements.
———
2、Git commit message optimized: We should edit git message and make it
meaningful
and concisely, which mean that committer should remove duplicate message or
event change
original message and make more sense.
Long commit message withs duplicate or unrelated it too hard to read when
developer run git blame
and try to found out what happened about some codebase.
An example here
https://github.com/apache/dolphinscheduler/commit/9508d1e9786cd2ec84e755854799431a927d6f3c
<https://github.com/apache/dolphinscheduler/commit/9508d1e9786cd2ec84e755854799431a927d6f3c>.
We should remove duplicate message "[Improvement][dao]When I search for the
keyword Modify User, the web UI shows empty #5428”
And remove unrelated "fix some issues of the code style”
[1]: https://spark.apache.org/improvement-proposals.html
<https://spark.apache.org/improvement-proposals.html>
[2]:
https://cwiki.apache.org/confluence/display/FLINK/Flink+Improvement+Proposals
<https://cwiki.apache.org/confluence/display/FLINK/Flink+Improvement+Proposals>
[3]:
https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists
<https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists>
Best Wish
— Jiajie
