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

docs: Added section on signing off commits #567

Merged
merged 5 commits into from May 13, 2024

Conversation

StandingPadAnimations
Copy link
Collaborator

This adds a section on signing off commits (noted to be optional, but useful), which is mostly a copy-paste of BpyBuild's section

To summarize: signing off commits is a way for the commit author to say, “Not only am I submitting this commit, the change made in this commit is allowed to be used”. This verifies:

  • The person submitting the commit indeed made the change (what happens most of the time)
  • The commit is based on existing code that is allowed to be used (ex. using code from another Blender addon, as all Blender addons are GPL licensed)
  • The change in the commit comes from someone who has given permission for the change to be submitted (although they should also sign off of the commit). This includes coauthors.

As this is optional (although encouraged), this won't impact existing contributions to MCprep.

Signed-off-by: Mahid Sheikh <mahid@standingpad.org>
Signed-off-by: Mahid Sheikh <mahid@standingpad.org>
Signed-off-by: Mahid Sheikh <mahid@standingpad.org>
Signed-off-by: Mahid Sheikh <mahid@standingpad.org>
@TheDuckCow
Copy link
Member

Getting to this now, for my understanding: is the difference here just a matter of adding additional text into one's commit? Or is this tied to some certificate setup (in which case, should we be linking to how to set that up)?

@StandingPadAnimations
Copy link
Collaborator Author

StandingPadAnimations commented May 13, 2024

Getting to this now, for my understanding: is the difference here just a matter of adding additional text into one's commit? Or is this tied to some certificate setup (in which case, should we be linking to how to set that up)?

Yep, just adding additional text to the commit. git-commit also has the flag --signoff, which adds this automatically based on one's .gitconfig. Here's an example of how it would look in git-log
image

It's based on trust that the developer is actually following the rules laid out in the Developer's Certificate of Origin when they sign off (although for us here, while stated to be a good practice, signing off is optional, similar to our commit recommendations)

@TheDuckCow
Copy link
Member

Got it, I think if we could include a link to some docs showing how to use the --signoff flag would be quite helpful for anyone trying to quickly understand this, myself included :)

Copy link
Member

@TheDuckCow TheDuckCow left a comment

Choose a reason for hiding this comment

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

Approving, presuming we'll add the context link showing how to use the signoff git flag

Signed-off-by: Mahid Sheikh <mahid@standingpad.org>
@StandingPadAnimations
Copy link
Collaborator Author

Done, I'll merge this in now

@StandingPadAnimations StandingPadAnimations merged commit 3a27084 into dev May 13, 2024
@StandingPadAnimations StandingPadAnimations deleted the sign-off-commits branch May 13, 2024 04:21
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

2 participants