question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Commit / PR naming conventions for

See original GitHub issue

Now that we have vanilla components, React components, and elements… many packages… how can our PRs use conventional commit syntax to generate package-specific changelogs?

E.g. I’m using the @carbon/react package for all React core components. How do I see what’s new?

E.g. I’m just using @carbon/button-react package, how can I see what’s new in each release?

Acceptance criteria:

  • Consistent commit and PR naming for all packages
  • Just root-level package Husky config or however we enforce conventional commit messages
  • Document this in /docs

P.S. I wonder if we should pull “contributing” content (syntax style, commit messages, sassdoc annotation style, etc) out of the .github directory and into /docs because the docs directory is much more discoverable.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
kinuengcommented, Jun 24, 2019

Could we add the PR/commit convention to a CONTRIBUTING.md file in carbon instead of the docs/developing.md?

The CONTRIBUTING.md has a step[1] that mentions briefly the commit message convention.

[1] https://github.com/carbon-design-system/carbon/blob/master/.github/CONTRIBUTING.md#8-make-a-pull-request

0reactions
stale[bot]commented, Jul 28, 2019

As there’s been no activity since this issue was marked as stale, we are auto-closing it.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Git Naming Convention > Pull Request Naming
Consists of two parts: Title: Short informative summary of the pull request; Description: More detailed explanatory text describing the PR for the reviewer ......
Read more >
Commit Naming Rules | Developer Experience Knowledge Base
Having a commit naming convention can be of great help, in maintaining the codebase and easing up the development process.
Read more >
How To Create a Great Pull Request in Just 5 Steps
A great pull request should have a clear name, followed by detailed descriptions and additional tags or labels. Pull request's name. The pull...
Read more >
Commit, review, and merge conventions - Github-Gist
There should be a naming convention in place. The name of the branch should contain sufficient detail as to the purpose of that...
Read more >
Conventional Commits
Commits MUST be prefixed with a type, which consists of a noun, feat , fix , etc., followed by the OPTIONAL scope, OPTIONAL...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found