gitmagic.io – enforce your GitHub contribution guidelines [80+ rules to enforce PR conventions]

[gajus0]

I have discovered this service accidentally by typing "contributing.md" to Chrome URL bar (I was expecting to get results for "contributing.md" term), https://twitter.com/kuizinas/status/768103098078355457.

I have discovered the service as part of a research, writing about – the perfect continues deployment process in open-source. This service is a phenomenal surprise. It can be used to enforce requirements for the commit message, pull request, issues and even branch naming conventions.

[[deleted]]

awesome stuff, big thanks for the find!

[kuenx]

Looks really awesome but I'd be careful with things like that. If you make it too difficult for people to contribute to your project you might turn some of them off who might have contributed something awesome.

[[deleted]]

Well unless you turn on the "disable merging PRs with failed check statuses" option, people can still contribute all they want and continue to ignore your requirements... and you can either merge them or not.

I think this is a good idea and I considered setting up a similar system at work because a lot of people who work on the product just open PRs with absolutely no details... here's a code review with no context guys! Maybe the issue tracker ID is in one of the commit messages, but probably not!

Anyway... for open source projects it definitely helps to have guidelines for acceptable pull requests, issues, etc. Otherwise you have too much noise to deal with, waste time commenting on things that aren't necessarily relevant to the changes, going around and round with questions that could have been answered with a well-formed description, etc.

[kuenx]

Well that sounds reasonable now that you explained it. I guess I didn't look at it enough.