community icon indicating copy to clipboard operation
community copied to clipboard

docs: expand on DCO using manual sign-off

Open tarilabs opened this issue 1 year ago • 8 comments

@hbelmiro wdyt? I had this gotchas when DCO didn't pass despite I've used the hook (in a project, the Name was different).

I'm also not sure the email of commit "must" match the github primary email, but that's for another time.

tarilabs avatar Aug 28 '24 06:08 tarilabs

bump @terrytangyuan @andreyvelich could this be merged, please? (I'm going through some backlog of pending PRs...) thanks

tarilabs avatar Sep 24 '24 07:09 tarilabs

Thank you for this PR @tarilabs! Can we move this doc to the Kubeflow website: https://www.kubeflow.org/docs/about/contributing/#sign-off-your-commits ? It would be nice to unify docs for our users and reduce number of places they need to research. cc @kubeflow/kubeflow-steering-committee

andreyvelich avatar Sep 24 '24 12:09 andreyvelich

Can we move this doc to the Kubeflow website: https://www.kubeflow.org/docs/about/contributing/#sign-off-your-commits ?

The website currently already links back to this doc which has more details.

terrytangyuan avatar Sep 24 '24 13:09 terrytangyuan

Can we move this doc to the Kubeflow website: https://www.kubeflow.org/docs/about/contributing/#sign-off-your-commits ?

The website currently already links back to this doc which has more details.

But this doc has very little information. @terrytangyuan Is there any problem to just move it in Kubeflow website ?

andreyvelich avatar Sep 24 '24 13:09 andreyvelich

This file has 13 lines of instructions, which could take 2/3 of the page or so (and that section is at the top of the page on the website). If contributors are already familiar with DCO, they don't need the details.

There are also instructions in this README that are specific to the commit hook so I think it would be better for code and instruction to stay close to each other.

terrytangyuan avatar Sep 24 '24 13:09 terrytangyuan

@terrytangyuan Why it will be the 2/3 page ? I can see that this file has 316 lines already: https://github.com/kubeflow/website/blob/master/content/en/docs/about/contributing.md?plain=1.

We can always create dedicated page in the website if we feel that this is additional information that users should read.

I just think that having unify place for docs will be easier for us to maintain, and easier for users to search.

Any thoughts @StefanoFioravanzo @hbelmiro ?

andreyvelich avatar Sep 24 '24 13:09 andreyvelich

Why it will be the 2/3 page

I meant that if we move these lines to that page, it would take up 2/3 of my screen before I can read the next sub-section "Follow the code of conduct". That page is TLDR and especially intimidating for first contributors IMO. We should move details to other places. Just my two cents though.

terrytangyuan avatar Sep 24 '24 14:09 terrytangyuan

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar May 24 '25 00:05 github-actions[bot]

I believe this would have been meaningful addition

tarilabs avatar May 24 '25 08:05 tarilabs

/approve since it improves the status quo. Please create follow up PRs if needed

juliusvonkohout avatar Jun 17 '25 14:06 juliusvonkohout

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: juliusvonkohout

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • ~~OWNERS~~ [juliusvonkohout]

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

google-oss-prow[bot] avatar Jun 17 '25 14:06 google-oss-prow[bot]