-
Notifications
You must be signed in to change notification settings - Fork 3
Frequently Asked Questions
Q1. What Issue does it solve?
A1. It solves the problem of contributors constantly violating commit and branch name guidelines followed by a specific repository, especially when you're working on large open-source projects. It also helps you maintain a coherent commit history when you're working on personal projects.
Q2. Won't it just create bad commit messages?
A2. No but, even if it does, you get an option to modify the suggested branch names and commit titles so that you're not bound by our tool.
Q3. Does it use a GitHub Issue Number?
A3. Yes, it does. But, if you're not working with well-organized Github Issues, you can enter the text manually. It's easier to write what you're working on before you've started working, as compared to when you're exhausted after completing a task.
Q4. Aren't emojis very far fetched?
A4. Maybe they are, but you can easily disable them. So, if the user fancies emoticons in their commit titles, they can use it.
Q5. Why won't I just use Git Hooks to check if the commit message follows a proper format?
A5. You can, but hooks are literally just checks. they won't actually "suggest" commit messages to the contributors.
Copyright (C) 2020 Rachit Gupta, Yash Khare, Shambhavi Aggarwal, and Preet Shah is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".