search

kubeflow / community

Information about the Kubeflow community including proposals and governance information.
Apache License 2.0
160 stars 220 forks source link

docs: expand on DCO using manual sign-off #744

Open tarilabs opened 2 months ago

tarilabs commented 2 months ago

@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.

google-oss-prow[bot] commented 2 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ederign Once this PR has been reviewed and has the lgtm label, please assign jbottum for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/kubeflow/community/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
tarilabs commented 1 month ago

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

andreyvelich commented 1 month ago

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

terrytangyuan commented 1 month ago

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.

andreyvelich commented 1 month ago

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 ?

terrytangyuan commented 1 month ago

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.

andreyvelich commented 1 month ago

@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 ?

terrytangyuan commented 1 month ago

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.