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

[KED-3049] Update contributors guide to include guidance on DCO #715

Merged
merged 11 commits into from
Jan 31, 2022

Conversation

antonymilne
Copy link
Contributor

@antonymilne antonymilne commented Jan 24, 2022

Description

As per kedro-org/kedro#1167 and kedro-org/kedro#1177, now that we're part of LF, we need all commits to be signed-off. I'm not a fan of this, but after spending far too much time on it I've come up with this workflow as the simplest possible one for now.

  1. make sign-off: this creates a git hook that will add the Signed-off-by line to all commit message. This is a better solution than aliasing git commit for various reasons
  2. require: members: false for the DCO GitHub app configuration. This means that signed commits (i.e. GPG or S/MIME signed, not signed-off) by members of kedro-org do not need to have the Signed-off-by line. In practice, this is very helpful because it means that any commits maintainers make on GitHub (applying code review suggestions, merging in main, etc.) will get ✅ for DCO check.

Possible future improvements

  • Enable allowRemediationCommits to make it easier for users to retroactively sign off commits
  • Maybe fork DCO app so that the "Set DCO to pass" button is available to all? (Might defeat the point of the check though...)

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: Antony Milne <antony.milne@quantumblack.com>
Signed-off-by: Antony Milne <antony.milne@quantumblack.com>
Signed-off-by: Antony Milne <antony.milne@quantumblack.com>
@antonymilne antonymilne changed the title Docs/update contributing dco#ked 3049 [KED-3049] Update contributors guide to include guidance on DCO Jan 24, 2022
antonymilne and others added 2 commits January 24, 2022 16:51
Signed-off-by: Antony Milne <antony.milne@quantumblack.com>
…-3049' into docs/update-contributing-dco#ked-3049
Copy link
Contributor

@rashidakanchwala rashidakanchwala left a comment

Choose a reason for hiding this comment

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

Thanks LGTM!

Copy link
Contributor

@studioswong studioswong left a comment

Choose a reason for hiding this comment

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

awesome work for setting up the docs and the sign off workfow 👍

@antonymilne antonymilne merged commit afe06a2 into main Jan 31, 2022
@antonymilne antonymilne deleted the docs/update-contributing-dco#ked-3049 branch January 31, 2022 11:27
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.

3 participants