Giter Club home page Giter Club logo

Comments (13)

chriscool avatar chriscool commented on August 19, 2024 1

The changes we requested have been taken care of by Gary, the GitCop guy, and I have changed the GitCop configuration for the go-ipfs repo.

Now the GitCop messages are attached to individual commits, so when the commit are fixed, the GitCop comment will be masked by default by GitHub.

Also as ipfs/community#126 is merged, each specific GitCop error message has been customized to have a link to a specific section in https://github.com/ipfs/community/blob/master/contribution-guidelines.md

from infra.

harlantwood avatar harlantwood commented on August 19, 2024

Hm, I think this page says max commit subject of 50 characters:

https://github.com/ipfs/community/blob/master/contribution-guidelines.md

from infra.

chriscool avatar chriscool commented on August 19, 2024

Yeah we can decrease it to 50, but I think it will make too much noise for not much gain as 80 should still be readable for most people.

It might only be better for people looking at commits from smartphones, as today terminals are usually much wider than 80 characters and web browsers on recent desktop or laptops also have no problem with 80 characters.

from infra.

jbenet avatar jbenet commented on August 19, 2024

ok 80 sounds good

from infra.

jbenet avatar jbenet commented on August 19, 2024

Maybe the gitcop message should mention the commit hook directly too

from infra.

jbenet avatar jbenet commented on August 19, 2024

@spikebike just had a hard time figuring out how to make this happen. maybe also have a couple of commands that guide people to amending their commits? (many people dont know how to use git rebase)

from infra.

chriscool avatar chriscool commented on August 19, 2024

@jbenet ok I will improve the GitCop message and https://github.com/ipfs/community/blob/master/docs/commit-message.md soon.

from infra.

 avatar commented on August 19, 2024

@chriscool can this be closed?

from infra.

chriscool avatar chriscool commented on August 19, 2024

Yes, let's close this.

from infra.

chriscool avatar chriscool commented on August 19, 2024

Sorry but I think we should probably reopen this, as it is referenced in the GitCop message where we ask people to provide their feedback in this issue.

from infra.

chriscool avatar chriscool commented on August 19, 2024

By the way the GitCop footer message is now:

We ask for a few features in the commit message for Open Source licensing hygiene and commit message clarity.
`git commit --amend` can often help you quickly improve the commit message.
[Guidelines](https://github.com/ipfs/community/blob/master/contribution-guidelines.md#commit-messages) and [a script](https://github.com/ipfs/community/blob/master/dev/tools/hooks/setup_commit_msg_hook.sh) are available to help in the long run.
Your feedback on GitCop is welcome on [this issue](https://github.com/ipfs/infrastructure/issues/23).

Tell me if you see something that can be improved in it.
But note that GitCop for now doesn't let us provide a customized error message for each different error that can trigger it.

The different errors that can trigger it are the following:

  • the subject is more than 80 characters long
  • the commit message doesn't contain:
License: MIT
Signed-off-by: user name <email@address>

from infra.

RichardLitt avatar RichardLitt commented on August 19, 2024

GitCop should delete it's comments when someone PRs a fix to the commit and there is no longer an issue.

from infra.

chriscool avatar chriscool commented on August 19, 2024

Yeah, that might be a good idea. I will suggest it.

from infra.

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.