Git Gud Commit

FAQ

What is this website?

Using this website, you will be able to determine the quality of commit messages in a Git repository. The phrase "git gud" originates from an Internet meme as an intentional misspelling of the phrase "get good".

How do you know if a commit message is 'good'?

Linus Torvalds, the creator of the Linux kernel and Git, has outlined what makes a good commit message here. Several developers have generalised these guidelines and created a set of 'rules' for commit messages. Using natural language processing techniques, commit messages can be analysed to determine whether they abide to these rules, and a score is assigned to the commit using a simple algorithm.

Why should I care about my commit messages?

Writing good commit messages is not only good practice, it can be considered essential for large-scale projects. If a user is searching for a commit which has broken something critical, the message, "yayy, it works! (i think)" is not going to help them determine whether that commit could have caused the issue. While commands such as "git blame" may make this easier, they do not help in cases where you are not sure which source files should be inspected.

While you shouldn't expect to write essays for each commit you make, a reasonable level of detail should be given, so the changes can be determined from just the message.

Is this website stealing my data?

Repositories are cloned/stored locally and are never accessed by, or stored on, any server.

For the analysis of a public repository via a GitHub URL, the web server which serves this website is running a proxy for GitHub.com, and the headers of any GET/POST requests to GitHub.com are slightly altered in order to bypass the CORS policy. The web server does not handle any repository data directly. Private and Enterprise repositories cannot be read via a URL, but can be read via an uploaded ZIP. The ZIP file and its contents are never uploaded to any server, and any analysis is performed locally.

Anything else I should know?

Check out the GitHub repository of this project here for more information. Feel free to analyse the repostitory with this tool if you want :)

Git Gud Commit is maintained by Baron Khan and licensed under the MIT License. Git Gud Commit is not affiliated with Git, GitHub or GitLab. The Git Logo by Jason Long is licensed under the Creative Commons Attribution 3.0 Unported License.