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

package: Add pre-commit hooks to enforce commit message style #12

Merged
merged 1 commit into from
Sep 9, 2020

Conversation

darinspivey
Copy link
Collaborator

We should do our best to enforce our desired conventional
commit style, especially since PRs may come from the
public. This sets up basic rules for validating the
conventional commit style.

Semver: minor
Ref: LOG-7183

package.json Show resolved Hide resolved
Comment on lines +87 to +101
"feat",
"deps",
"fix",
"docs",
"package",
"style",
"refactor",
"test",
"revert",
"WIP"
Copy link
Member

Choose a reason for hiding this comment

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

this set looks fine to me, same comment about recent commits failing this, but then again there wasn't a standard before 😄

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, this is all mostly standard, so I just went with it. I added deps, package, WIP

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I see I used improvement recently, but that's kinda like feat. Technically, everything is an improvement.

Copy link

Choose a reason for hiding this comment

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

@darinspivey, which one is gonna be used for deprecating the feature? For example, on LogDNA Agent, I have recently removed WinEvent Logging Component; so, which one from this list would be the best one describing that?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'd say refactor for that. Then the subject can still say something about "refactor: removed xx because blah blah"

Copy link

Choose a reason for hiding this comment

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

Does it work for backward-incompatible removals too? Just wondering...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, it only applies moving forward with new commits. I don't think we need to worry about retroactively applying it.

package.json Show resolved Hide resolved
@mdeltito mdeltito self-assigned this Sep 8, 2020
We should do our best to enforce our desired conventional
commit style, especially since PRs may come from the
public.  This sets up basic rules for validating the
conventional commit style.

Semver: minor
Ref: LOG-7183
Copy link

@smusali smusali left a comment

Choose a reason for hiding this comment

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

I think we can add this to everything written on js, right? So, what's stopping us from applying the same thing onto (e.g.) the agent or you have already started doing that?

@darinspivey
Copy link
Collaborator Author

I think we can add this to everything written on js, right? So, what's stopping us from applying the same thing onto (e.g.) the agent or you have already started doing that?

We will definitely add this across public repositories. I'm just using this as a way for us to feel it out.

@smusali smusali self-requested a review September 9, 2020 16:20
@darinspivey darinspivey merged commit 29a1f03 into master Sep 9, 2020
@darinspivey darinspivey deleted the darinspivey/LOG-7183 branch September 9, 2020 18:15
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.

None yet

3 participants