Skip to content

fix(README.md): add examples to Git Commit Guidelines in README.md #590

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.

Sign up for GitHub

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

Jump to bottom
Merged
dtaylor113 merged 1 commit into from
Aug 28, 2017
Merged

fix(README.md): add examples to Git Commit Guidelines in README.md #590

dtaylor113 merged 1 commit into from
Aug 28, 2017

Conversation

@benjaminapetersen
Copy link
Member

@benjaminapetersen benjaminapetersen commented Aug 23, 2017 •
edited
Loading

Updates the Git Commit Guidelines with a few additional examples to help ensure future PRs can easily conform to desired commit message structure.

PR made in reference to this comment & this comment.

@jeff-phillips-18

@benjaminapetersen
Copy link
Member Author

benjaminapetersen commented Aug 23, 2017

Quick Q, should there be more than fix, perf, and feat? I see one example in the history:

chore(pfToolbar): fix typo in directive name and link from 'componenet' to 'component'

chore is not doc'd here.

@dtaylor113
Copy link
Member

dtaylor113 commented Aug 23, 2017

Hi, chore will be merged but not update the version at all. Yeah, I didn't see it documented either, but that is what it does :-)

@jeff-phillips-18
Copy link
Member

jeff-phillips-18 commented Aug 23, 2017

Correct, chore is documented in the link but not here.

This should be a chore so as not to cause a release.

dtaylor113
dtaylor113 reviewed Aug 23, 2017
View reviewed changes
README.md Outdated
[![Join the chat at https://gitter.im/patternfly/angular-patternfly](https://badges.gitter.im/patternfly/angular-patternfly.svg)](https://gitter.im/patternfly/angular-patternfly?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# AngularJS directives for [PatternFly](https://www.patternfly.org)
# AngularJS directives for [PatternFly](https://www.patternfly.org)
Copy link
Member

@dtaylor113 dtaylor113 Aug 23, 2017

Choose a reason for hiding this comment

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

This should probably be rewritten as "AngularJS components..."

Copy link
Member Author

@benjaminapetersen benjaminapetersen Aug 23, 2017

Choose a reason for hiding this comment

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

I can quick update that to components.

@benjaminapetersen
Copy link
Member Author

benjaminapetersen commented Aug 23, 2017

So something like:

##### Non-Release

chore(foo): some minor change that should not trigger an automated release.

@dtaylor113
Copy link
Member

dtaylor113 commented Aug 23, 2017

So something like:

Non-Release

chore(foo): some minor change that should not trigger an automated release.

Yes, that would be perfect

@benjaminapetersen
Copy link
Member Author

benjaminapetersen commented Aug 23, 2017

Done

@dtaylor113 dtaylor113 merged commit a07d2c7 into patternfly:master Aug 28, 2017
@benjaminapetersen benjaminapetersen deleted the bpeterse/contrib-update branch August 28, 2017 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeff-phillips-18 jeff-phillips-18 jeff-phillips-18 approved these changes

+1 more reviewer

@dtaylor113 dtaylor113 dtaylor113 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@benjaminapetersen @dtaylor113 @jeff-phillips-18