This is an archive of the discontinued LLVM Phabricator instance.

[docs] Move code contribution from GettingStarted.rst to Contributing.rst
ClosedPublic

Authored by MaskRay on Jul 7 2022, 12:33 AM.

Details

Summary

For code contribution, GettingStarted.rst duplicates information in Contributing.rst.
The dedicated Contributing.rst is a better place for code contribution, so move
the content there.

Notes:

  • D41665 added Contributing.rst
  • D110976 mentioned git cherry-pick e3659d43d8911e91739f3b0c5935598bceb859aa workaround

Diff Detail

Event Timeline

MaskRay created this revision.Jul 7 2022, 12:33 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 7 2022, 12:33 AM
Herald added a subscriber: StephenFan. · View Herald Transcript
MaskRay requested review of this revision.Jul 7 2022, 12:33 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 7 2022, 12:33 AM
MaskRay updated this revision to Diff 442803.Jul 7 2022, 12:40 AM

minor adjustment

MaskRay edited the summary of this revision. (Show Details)Jul 7 2022, 12:41 AM
MaskRay added reviewers: silvas, smeenai.
fhahn accepted this revision.Jul 7 2022, 6:04 AM

LGTM, thanks!

This revision is now accepted and ready to land.Jul 7 2022, 6:04 AM
cjdb accepted this revision.Jul 7 2022, 10:09 AM
nickdesaulniers accepted this revision.Jul 7 2022, 10:36 AM
nickdesaulniers added inline comments.
llvm/docs/Contributing.rst
57–62

Consider adding punctuation to your added point, then making the whole bulleted list consistent.

91–92

Consider adding something to denote we also no longer use the mailing list?

and the llvm-commits mailing list is deprecated?

136–138

I'm a big fan of:

$ git rebase --onto main --root branch-with-change

which will rebase branch-with-change onto main, then checkout branch-with-change.

144

Isn't it necessary to merge branch-with-change into main before pushing main?

i.e. I would do:

$ git checkout main
$ git pull
$ git rebase --onto main --root branch-with-change
$ ninja check-$whatever
$ git checkout main
$ git merge -
$ git pull --rebase
$ git push

I guess you're suggesting pushing from the development branch? I guess that should be fine.

MaskRay updated this revision to Diff 442989.Jul 7 2022, 10:49 AM
MaskRay marked 4 inline comments as done.

address comments

MaskRay added a comment.EditedJul 7 2022, 10:49 AM

Thanks for the suggestion. This is mostly a doc move. The important part is that we agree that the code contribution part from GettingStarted.rst can be moved to Contributing.rst, which I assume we have achieved.
I did not intend to change too much wording and try to keep existing paragraphs. I'll push this shortly as @nickdesaulniers seems to have more planned improvement.

llvm/docs/Contributing.rst
91–92

There are quite a few llvm-commits which may need to be reworded after the Discourse migration.
I just add back a sentence to denote what we used to do.

144

Thanks for the suggestion. This is mostly a doc move from Contributing.rst. The important part is that we agree that the code contribution part from GettingStarted.rst can be moved to Contributing.rst, which I assume we have achieved.

This revision was landed with ongoing or failed builds.Jul 7 2022, 10:51 AM
This revision was automatically updated to reflect the committed changes.