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

MAINT: Create commit guidelines #4275

Merged
merged 1 commit into from Jun 16, 2020

Conversation

Krzmbrzl
Copy link
Member

No description provided.

COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
@Kissaki
Copy link
Member

Kissaki commented Jun 10, 2020

We will probably have more guidelines, so I would rather put them into a subfolder for that?

docs/contribution-guidelines/? docs/project-guidelines?

COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
@Kissaki
Copy link
Member

Kissaki commented Jun 10, 2020

I think it is worth establishing context and goals as in describe how features will have multiple commits and then a PR and (equal) merge commit with summarizing the changes as a whole.

@Kissaki
Copy link
Member

Kissaki commented Jun 10, 2020

Missing secondary footer (functionality) like

Co-Authored-By: Author <author@example.com>

COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
@Krzmbrzl
Copy link
Member Author

We will probably have more guidelines, so I would rather put them into a subfolder for that?

Yes I thought so as well but as long as we don't have additional files (nor a CONTRIBUTE.md) I thought it might be best to place it somewhat visibly in the project's root.

I think it is worth establishing context and goals as in describe how features will have multiple commits and then a PR and (equal) merge commit with summarizing the changes as a whole.

I agree on the PR side, but I think a new feature should only be a single commit. You might have previous commits that e.g. refactor the code base in the way you need for the feature but these would be covered by our commit guidelines as well...

@Kissaki
Copy link
Member

Kissaki commented Jun 11, 2020

Having seen the TYPE prefix on commits now I like them.

@Krzmbrzl
Copy link
Member Author

Does someone still have something to add to the guidelines? Or something that you think needs to be changed?

Copy link

@felix91gr felix91gr left a comment

Choose a reason for hiding this comment

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

I feel you've done a great job! Making decent guides is no easy task, and this one feels pretty good to me :)

COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
@Krzmbrzl
Copy link
Member Author

@felix91gr all done (I think) :)

@felix91gr
Copy link

LGTM

I left a small feedback on the Summary comment because I didn't explain myself well yesterday, but otherwise I think this is a-okay :)

@Krzmbrzl
Copy link
Member Author

Ah okay now I understand. I was thinking you were referring to writing summary with a capital letter :)
I also added the code-formatting to Message Body and Footer ☝️

COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
COMMIT_GUIDELINES.md Outdated Show resolved Hide resolved
@Krzmbrzl Krzmbrzl merged commit 73c535b into mumble-voip:master Jun 16, 2020
@Krzmbrzl Krzmbrzl deleted the commit-guidelines branch November 9, 2022 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants