Skip to content
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

Closed
wants to merge 1 commit into from
Closed

docs: some thoughts #82

wants to merge 1 commit into from

Conversation

ajoslin
Copy link
Contributor

@ajoslin ajoslin commented Aug 10, 2015

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.

###### path

Type: `string` Default: `'package.json'`

The location of your "package.json".

###### transform
Copy link
Contributor Author

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.

Copy link
Member

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.

@stevemao
Copy link
Member

The reason I didn't make angular as default are:

  1. I don't want to be opinionated.
  2. Like you said some people "hate" angular's conventions (hate is probably not accurate).
  3. I checked a lot of other projects' conventions and I think they work nicely too. For example: jQuery's convention is also used widely and there are certain nice things about it.

I don't mind making angular as standard. I suggest that we should make it a vote? While this PR addresses other issues too so I'll open another one.

@stevemao
Copy link
Member

In the docs, I think it's good if we ask user to alias the command. and put the changelog script in package.json.

@stevemao stevemao closed this in f1b72fe Aug 15, 2015
@stevemao stevemao deleted the easy-docs branch August 15, 2015 12:48
@ajoslin
Copy link
Contributor Author

ajoslin commented Aug 15, 2015

Nice. The new README is a huge step in the right direction.

@stevemao
Copy link
Member

Thanks for the suggestion @ajoslin :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants