Comments (13)
Thank you for submitting this
First, this convention is not invented by me. Angular project first adapted it and it is used by a lot of projects now. You don't have to remember the rule but you can choose weather to use it in your project.
Second, you don't have to follow this rule to use this module. This module tries to parse your commits based on this rule but if certain bits are missing, it will be null and pass it to downstream.
Last, you can use a pre commit hook in your project along with this one. I won't include a precook module in this one because of separation of concerns. I'm not sure if there's an existing one for angular but if not, anybody can write one.
Sent from my iPhone
On 9 Apr 2015, at 7:31 am, Jim Cummins [email protected] wrote:
Hi Steve,
Wasn't sure where to put this or how I could reach out to you other than Github so please close as needed.
I think the conventional commit format is great but IMO there is a missing piece right now for people who just want to make commits to a repo without remembering the exact formatting spec that a repo author prefers. Sometimes I want to commit to a repo and there is a specific format that the repo author prefers. This is great but ideally I, as the contributor, would prefer to be prompted for the required commit message fields rather than having to remember the convention of every repo. It also isn't helpful for ides or scm tools that might want to change their behavior based on a repo's preferred commit format.
Git pre-commit hooks are great for stopping me, the one-off contributor, from doing harm, but from a tooling perspective they leave something to be desired because they don't actively prompt me for the require commit fields using something like inquirer.
So I wanted to get your pulse on this so see if you think it would be possible or even preferable to have some sort of config file that repo authors could include in the repo that defines certain norms when it comes to commit messages.
Since you're writing the updated parser and writer for changelog, I figured it was worth checking in. I haven't worked out the details yet but my guess is that it would be something like .commitformat or .commitconvention
Any overlap between this and what you're working on?
Thoughts.
—
Reply to this email directly or view it on GitHub.
from conventional-commits-parser.
Thanks. I think I understand. Appreciate it.
from conventional-commits-parser.
I think https://github.com/jzaefferer/commitplease might do
from conventional-commits-parser.
Thanks. Looks like a commit hook. Angular already has one here: https://github.com/angular/angular.js/blob/master/validate-commit-msg.js
I guess my point is that I'd like something that the user can run that explicitly asks for the fields rather than using true/false.
from conventional-commits-parser.
So you want something like this:
What's the type:
> fix
What's the scope
> $http
What's the subject
> make it work
from conventional-commits-parser.
Yep! And I know how to accomplish this using Inquirer but figured there might be more conventions than the one used by the Angular team (you mentioned the JQuery example) and a good tool would look to the repo for a config file to determine these questions.
from conventional-commits-parser.
I guess if user can configure the rules that would be great
from conventional-commits-parser.
👍 Thanks. This inspires me
from conventional-commits-parser.
Great! Thanks for your work on conventional commit. It looks great. Excited for the eventual merge.
from conventional-commits-parser.
If you wanna do it, go ahead and let me know. If not, I'll eventually do it. Thanks for this idea.
from conventional-commits-parser.
@stevemao I have some alpha code for this. It works pretty well. Will post soon.
from conventional-commits-parser.
@stevemao Released Commitizen here: http://commitizen.github.io/cz-cli/
Would appreciate any feedback.
from conventional-commits-parser.
Will have a look when I have time. Thanks @jimthedev
from conventional-commits-parser.
Related Issues (20)
- Change header pattern so that it can match any number of parts
- Support prefixes for issues HOT 5
- expose owner :D
- expose lib/parser as a sync function
- trim all parts
- Should preserve newlines in a part HOT 1
- change issuePrefixes to referencePrefixes HOT 1
- expose msg.reference.referencePrefix
- noteKeywords should be case insensitive
- Using a regex for issuePrefixes HOT 21
- any noteKeywords must be at the beginning of a sentence.
- mentions `@` support
- referencing a commit in parenthesis results in a parsing error HOT 3
- Merge Request ID for GitLab HOT 5
- Apparently "important changes" may have more than one paragraph HOT 1
- Support other formats of references HOT 1
- CLI
- make `headerPattern` more flexible
- regex tests are not useful
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from conventional-commits-parser.