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

Add Conventional Commits to Contributor section of README #862

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

waltjones
Copy link
Contributor

Fixes #860

This does not add commitizen to project dependencies, based on nodejs.org recommendation:

If you’re installing something that you want to use in your program, using require('whatever'), then install it locally, at the root of your project.

If you’re installing something that you want to use in your shell, on the command line or something, install it globally, so that its binaries end up in your PATH environment variable.

https://nodejs.org/en/blog/npm/npm-1-0-global-vs-local-installation/

@ArturMoczulski
Copy link
Contributor

In rollbar-php I added commitizen as a dev dependency. Do you think that's not a good idea?

@waltjones
Copy link
Contributor Author

I think it has to added globally to use it, and I also needed a ~/.czrc for things to work. So I don't know if there's any advantage to also adding as a dev dependency.

@ArturMoczulski
Copy link
Contributor

Cool. Let me double check how I did it for PHP

@ArturMoczulski
Copy link
Contributor

ArturMoczulski commented Apr 25, 2019

Ok, I agree with. I will use your README.md guidelines to be used in the PHP SDK as well. Although in the example, I would add the fix #[github_issue] and re #[github_issue] part even though is optional to encourage contributors more to be clear what issue the commit is related to. Possibly the scope as well. Like this:

fix(logging messages): apply logger formatting to Rollbar messages

fix #311

@ArturMoczulski
Copy link
Contributor

Also I would an example in the contrib section how to structure the commit message if there are breaking changes. This is all in the conventional changelog docs, but I'd still add it. What do you think?

@ArturMoczulski
Copy link
Contributor

I made those modifications in the PHP repo: rollbar/rollbar-php#450

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

Successfully merging this pull request may close these issues.

Make the repo commitizen-friendly
2 participants