search

darwinia-network / dj

Darwinia bridge relayer tool implemented in nodejs
GNU General Public License v3.0
4 stars 5 forks source link

Improve CI #49

Closed wi1dcard closed 4 years ago

clearloop commented 4 years ago

Have you every yarn before editing files? @wi1dcard

The conventional commit message seems not triggered.

wi1dcard commented 4 years ago

Have you every yarn before editing files? @wi1dcard

The conventional commit message seems not triggered.

Nope. You mean we set up the Git hook checking the commit message format in order to make sure it conforms to Conventional Commits?

Although personally I prefer the commit message just to be 1) written in English, 2) written in natural language (instead of code language), 3) describes the propose of the commit. I still look forward to having a commit message style guide for us developers in every single repo. As you said before, I believe the Conventional Commits is a good example.

Since all the repos are not maintained by a single developer, I strongly suggest we have a discussion and make a decision which commits style we should use. Then setup on CI instead of using Git hooks. This will make a lot of advantages, for example:

  1. We can not require all the developers (just like me) to run yarn install before they contribute. Some of the developers prefer using Web IDE, or perhaps they just want to correct a small typo in docs.
  2. Git hooks make git commit running longer than without hooks.
  3. While we are developing in feature branches, there is a chance that we just commit for testing and at that time we have no idea of the accurate commit message. Since CI failures can block PRs, however, Git hooks block commits. We have to make sure every commit conforms to lint.
  4. Finally, the most important issue I would have to say, I don't really like there's any "hidden mechanism" modifying my git config, affecting git operations. For people like me who have no idea of the config, I have to read husky docs to get understand why git is not performing as always. That might be bothering.

Hope we can improve the style guide of commits and its lint process!

wi1dcard commented 4 years ago

@clearloop Fixed commit messages. The PR is ready for review.