search

amundsen-io / amundsen

Amundsen is a metadata driven application for improving the productivity of data analysts, data scientists and engineers when interacting with data.
https://www.amundsen.io/amundsen/
Apache License 2.0
4.4k stars 954 forks source link

Feat: Semantic PR title check #459

Closed feng-tao closed 4 years ago

feng-tao commented 4 years ago

Leverage either prlint or https://github.com/zeke/semantic-pull-requests to do semantic pr title check for each different repos.

feng-tao commented 4 years ago

cc @Golodhros @ttannis @dikshathakur3119 @jinhyukchang What do you all think? I was talking to Marcos today and felt that this could help us to make the pr title cleaner which could benefit us to have a organized changelog.

ttannis commented 4 years ago

What features would we leverage, just the title pattern option or is there anything else?

feng-tao commented 4 years ago

mostly title pattern to follow this convention (e.g https://github.com/lyft/amundsendatabuilder/pull/265). Then I think if we built out changelog/milestone doc, it will be easier to understand which commit is for what purpose. It seems that quite some OSS projects have done this recently (e.g https://github.com/apache/incubator-superset/blob/master/.github/prlint.json for superset)

ttannis commented 4 years ago

I'm in favor of it, especially if we can leverage it for changelogs. So far it's been a very manual process of looking through old commits to try to write better release notes for the frontend releases where we tend to batch a several weeks of work.

Golodhros commented 4 years ago

Awesome!

I didn't know about prlint, it looks like a superior solution. It allows to also check the branch names, labels, the content of the PR and more. I would go with that one!

I would suggest to start with the PR title and some plain basic requirements for the PR description content.

feng-tao commented 4 years ago

sounds good, I just installed the prlint app on all six repos. I will create a simple prlint file for each repo.

feng-tao commented 4 years ago

https://github.com/lyft/amundsen/pull/460