Code Monkey home page Code Monkey logo

Comments (9)

vonglasow avatar vonglasow commented on June 12, 2024 1

The best way is to have it on our side to be sure we can't commit something with wrong message. We can use for that grumphp or we can inspire from it to be sure we have something equal for each library. Another thing is to provide a template (if necessary) to pre-fill the commit message.

Regarding the syntax it may be difficult to define the scope so only the prefix as fix: or feat: could be used the scope will be explain in title and commit message after.

As this verification could be bypassed we must add it also on our side. But if we restrict it to be consistent about some format or anything else we should provide an help to use it.

@Pierozi we can add in travis build some verification to be sure it's ok.

from central.

CircleCode avatar CircleCode commented on June 12, 2024 1

Be careful, generally speaking, preventing someone to commit (even if this is to increase code quality) is considered a bad practice: git concept is commit as often and as quickly as you need.
Additionally, since every commit can be rewritten, we do not need to ensure its consistency while it is on the developer computer.
I'd rather suggest a tool that could be launched manually (by default, it would check every commit between head and upstream branch), for which we can choose the range to analyze.
This tool would then be launched on before push on the client side, and on before receive on server side.

from central.

Pierozi avatar Pierozi commented on June 12, 2024

👍 Beautiful changelog generate, can't agree more !
Did you know if a github bot exist to check the commit message format ?

from central.

Hywan avatar Hywan commented on June 12, 2024

Github is a mirror for us, just like Gitlab or Pikacode. So we can add a hook on our own Git server at https://git.hoa-project.net. Thoughts?

from central.

Pierozi avatar Pierozi commented on June 12, 2024

Yup but we use github to accept pull request. same as travis build.
idea is to have PR blocked until commit message fit the expected.

from central.

Pierozi avatar Pierozi commented on June 12, 2024

Yep i like grumphp, that could be enough. Great idea!

from central.

Hywan avatar Hywan commented on June 12, 2024

@CircleCode I would highly go on your side.

Should a dry-run mode on hoa devtools:snapshot --only-changelog --dry-run would be adequate?

from central.

Pierozi avatar Pierozi commented on June 12, 2024

🤔 Ok, that could be a part of our Contributor guide, like we ask to run CS before submitting PR.
that's make sense

from central.

vonglasow avatar vonglasow commented on June 12, 2024

I am agree with @CircleCode but this not means we should not provide a kind of tools (helper). We should provide a way to be able to do it on our side. In my case, I prefer to have an error when I try to commit and which explain what I have missed than waiting few weeks for a review and tell me the commit message have a wrong format.

Using Grumphp will force contributors to respect our guideline it's maybe too restrictif, so we should not force people to use it but recommend it. And we should provide an easy way to implement it.

from central.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.