Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs(CONTRIBUTING.md): add note about scope wildcard #15326

Merged
merged 1 commit into from
Nov 1, 2016

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Oct 28, 2016

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

docs update

What is the current behavior? (You can also link to an open issue here)

no hint that * is a valid scope -- it hints you could omit the (...) bit, but most commits of late don't

What is the new behavior (if this is a feature change)?

documentation of *

Does this PR introduce a breaking change?

no

Please check if the PR fulfills these requirements

Other information:

@@ -249,6 +249,8 @@ Must be one of the following:
The scope could be anything specifying place of the commit change. For example `$location`,
`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...

You can use `*` if there isn't a more fitting scope.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to my (unofficial) understanding, I would say * is for when the change affects more than a single scope.

@Narretz
Copy link
Contributor

Narretz commented Oct 31, 2016

Wasn't there a goodle doc where these guidelines originate from? Here: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

It doesn't mention the asterisks or leaving out the scope, maybe it's not the latest version?

@jsoref
Copy link
Contributor Author

jsoref commented Oct 31, 2016

@Narretz: @stevemao talked about that url in #12032 (comment) when CONTRIBUTING.md was modified to mention optional scope. @petebacondarwin claimed to have updated the Google Doc. Unfortunately, I can't see the revision history for that file, so I can't see what happened, afaict, the optional scope bit is not present in that document at this time.

Further, If there's a document like that, CONTRIBUTING.md should reference it too...

@stevemao
Copy link
Contributor

You can use * if there isn't a more fitting scope.

I thought this was true... I don't think this is in any doc yet.

@petebacondarwin petebacondarwin merged commit bdf9602 into angular:master Nov 1, 2016
@jsoref jsoref deleted the contributing-scope branch November 1, 2016 14:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants