New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: some thoughts #82
Conversation
###### path | ||
|
||
Type: `string` Default: `'package.json'` | ||
|
||
The location of your "package.json". | ||
|
||
###### transform |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two options named transform. I deleted one, but I'm not really sure what's up there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah they do different things (bad name). The one under pkg is to tweak the parsed package.json a bit. It is used by conventional-github-releaser
where you need to prepend a leading 'v'
in version.
The reason I didn't make angular as default are:
I don't mind making angular as |
In the docs, I think it's good if we ask user to alias the command. and put the changelog script in package.json. |
Nice. The new README is a huge step in the right direction. |
Thanks for the suggestion @ajoslin :) |
The point of this is to spark a discussion about making simpler defaults for this project.
These wording changes assume that we make angular the default and rename it to
standard
or something similar.Why should there be an opinionated default? Because this project's current defaults just give you a formatted and sorted version of
git log
, which isn't very helpful.Why should angular be the default? Because angular's conventions make the most sense and are easy for people to adopt (if we document them well).
Why rename the angular presets to
standard
? Because lots of people in the npm community hate AngularJS. But whether you like angular or not, the conventions are worth using.I don't intend this to be merged yet.