+1 From: CalvinKirs <[email protected]> Date: Thursday, September 9, 2021 at 11:32 AM To: [email protected] <[email protected]> Subject: Re:[DISCUSS] Optimize DolphinScheduler git flow and git commit message External Email
+1; Great suggestion If there is no objection in the final discussion, we can write it into specification documents to facilitate contributors or maintainers to read. Best Wishes！ CalvinKirs, Apache DolphinScheduler PMC On 09/9/2021 11:17，Jiajie Zhong<[email protected]> wrote： Hey guys, I found out DolphinScheduler main repo https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fdolphinscheduler&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Pmzx6a1Q5rb8FbQ658pYMD1hKebYh2LUL7d1VOIOjEk%3D&reserved=0 <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fdolphinscheduler&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Pmzx6a1Q5rb8FbQ658pYMD1hKebYh2LUL7d1VOIOjEk%3D&reserved=0> 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://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fdolphinscheduler%2Fpull%2F6124&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=82M%2FuXv92YavOxhs8rau4PVTWn04AP38VSqs7PxK92w%3D&reserved=0 <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fdolphinscheduler%2Fpull%2F6124&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=82M%2FuXv92YavOxhs8rau4PVTWn04AP38VSqs7PxK92w%3D&reserved=0>. 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://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fdolphinscheduler%2Fcommit%2F9508d1e9786cd2ec84e755854799431a927d6f3c&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=PC1ghKhO5lj3JKvD%2FCT9plSQjOwhrY8c4IyTGiPvZSQ%3D&reserved=0 <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fdolphinscheduler%2Fcommit%2F9508d1e9786cd2ec84e755854799431a927d6f3c&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=PC1ghKhO5lj3JKvD%2FCT9plSQjOwhrY8c4IyTGiPvZSQ%3D&reserved=0>. 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://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fspark.apache.org%2Fimprovement-proposals.html&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202761757%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=DOg2EGBA6dVATVE%2FHCyXkLNPb1a2xi1KFavYZOlflhs%3D&reserved=0 <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fspark.apache.org%2Fimprovement-proposals.html&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202771750%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=efDA0OKCtTNlh9G9BoWktpjDKd1smolN%2FOvwLgAGd3k%3D&reserved=0> [2]: https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcwiki.apache.org%2Fconfluence%2Fdisplay%2FFLINK%2FFlink%2BImprovement%2BProposals&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202771750%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=ViT2%2BZ%2FMCilo4E4T%2FMWAvdHLsLdf%2BYx0gSB2lghQnfo%3D&reserved=0 <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcwiki.apache.org%2Fconfluence%2Fdisplay%2FFLINK%2FFlink%2BImprovement%2BProposals&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202771750%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=ViT2%2BZ%2FMCilo4E4T%2FMWAvdHLsLdf%2BYx0gSB2lghQnfo%3D&reserved=0> [3]: https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.github.com%2Fen%2Fissues%2Ftracking-your-work-with-issues%2Fabout-task-lists&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202771750%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Kb7OTRzA865RcYPahyfD0ttAsT%2FjvukxprDZyy7LK0k%3D&reserved=0 <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.github.com%2Fen%2Fissues%2Ftracking-your-work-with-issues%2Fabout-task-lists&data=04%7C01%7Cweruan%40ebay.com%7Ccff01b08c39b4be3031508d9734260b3%7C46326bff992841a0baca17c16c94ea99%7C0%7C0%7C637667551202771750%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Kb7OTRzA865RcYPahyfD0ttAsT%2FjvukxprDZyy7LK0k%3D&reserved=0> Best Wish — Jiajie
