docs: add forking instructions + workflow + fix contributing notes #16025
Conversation
nbusseneau
added
area/documentation
There was a problem hiding this comment.
(Looks good to me from the docs-structure point of view.)
Working from a fork will make it harder for contributors to rebase their PRs, no? Would that make sense instead to work on cilium/cilium but to add the fork as a distinct remote for pushing the changes?
Can you clarify which rebase scenario you think is harder? 🤔 As for using (As an aside note, I was under the impression the thing I've just documented is what we actually were supposed to be doing for quite some time now :D) |
nbusseneau
force-pushed
the
pr/fork-documentation
branch
from
157e5af
to
7310c10
Compare
There was a problem hiding this comment.
As for using
cilium/ciliumand having the fork as a separate remote: I think this is a bad idea.
Re-reading your PR, I'm not sure what I had in mind. Agreed that cloning the fork and adding cilium/cilium as upstream remote is the same thing as cloning the latter and adding the fork as a remote. I probably got confused somewhere on my first review, apologies.
Looks good, couple of nits.
Should help ensure Git newcomers properly manage their forks w.r.t. to the upstream remote. Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
nbusseneau
force-pushed
the
pr/fork-documentation
branch
from
7310c10
to
e866f4c
Compare
- Several notes in the contributing guide were not displayed on the page due to a missing semi-colon. - Moved the note about `git commit -s` to its proper place. - Also standardized whitespace around sub-items in "Making changes". Signed-off-by: Nicolas Busseneau <nicolas@isovalent.com>
pchaigno
added
the
ready-to-merge
nbusseneau
force-pushed
the
pr/fork-documentation
branch
from
e866f4c
to
7bc182d
Compare
|
Sneaky push to fix commit logs... (no #topys in there, I swear, don't need to look 😇) |
|
See individual commits.