mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-03-01 11:20:59 +03:00
Add commit message guidelines #110
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @sauerj on GitHub (Dec 17, 2018).
The emby repository is full of bad commit messages. Mostly only a title is provided but no information what the commit changes and why these changes are made. References to issues the commit is fixing are missing to.
The latest commit to the jellyfin repository seems to follow the same puristic commit message style.
I know writing good commit messages takes some time but it will help make jellyfin a much better place than the emby repo is.
It will help contributors or code reviewers to understand what a commit is trying to do and why.
Please do not take this personally, I really do appreciate all your work on jellyfin, just want to make jellyfin better and much more open than emby will ever be.
@PrplHaz4 commented on GitHub (Dec 17, 2018):
I think these are good recs (per https://chris.beams.io/posts/git-commit/)
More detail/guidelines available at the link, but I tried to pull out what I thought was most important.
@anthonylavado commented on GitHub (Dec 17, 2018):
We've read the Chris Beams post and agree. We are working on this.
@sparky8251 commented on GitHub (Dec 28, 2018):
I'm willing to take a crack at writing up this wiki document if you'd like. At the very least, I can do most of the legwork so you guys don't have to spend as much time on it.
@JustAMan commented on GitHub (Dec 28, 2018):
Feel free to!
@sauerj commented on GitHub (Jan 5, 2019):
It is also recommended to split commits into logical pieces.
A commit which fixes an issue should not change other code than needed to fix the issue. Personally I think it should not even be in the same PR that a fix for a certain issue.
@anthonylavado commented on GitHub (Apr 9, 2019):
We have this covered in https://jellyfin.readthedocs.io/en/latest/contributor-docs/contributing-code/#pull-request-guidelines