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

[Docs]: Add some more documentation on how to work with github. #915

Conversation

PhilipMetzger
Copy link
Contributor

@PhilipMetzger PhilipMetzger commented Dec 18, 2022

The document roughly describes some workflows, which help new users to start with github.

@superpippo12 Discord self ping.

Rendered

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have added tests to cover my changes

@google-cla
Copy link

google-cla bot commented Dec 18, 2022

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

docs/github.md Outdated Show resolved Hide resolved
docs/github.md Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch 3 times, most recently from 78c912e to 8926b03 Compare December 21, 2022 20:05
docs/github.md Outdated Show resolved Hide resolved
@PhilipMetzger
Copy link
Contributor Author

There are only a few things missing from this doc, but generally it's ready.

@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch from 8926b03 to ad93cc0 Compare December 21, 2022 21:49
@martinvonz
Copy link
Member

martinvonz commented Dec 22, 2022

There are only a few things missing from this doc, but generally it's ready.

Okay, I'll click the "Ready for review" button :)

@martinvonz martinvonz marked this pull request as ready for review December 22, 2022 05:34
@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch from ad93cc0 to 31d5585 Compare December 22, 2022 21:39
@PhilipMetzger
Copy link
Contributor Author

PhilipMetzger commented Dec 22, 2022

i'll need to tidy up the revsets section and then it's ready. If you see sentences which I could structure better, I'll gladly change them.

docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch from 31d5585 to 526d9f9 Compare December 27, 2022 22:28
@PhilipMetzger
Copy link
Contributor Author

Since the last Revision, I removed both the Git and Mercurial sections and introduced @martinvonz suggestion as basic workflow. PTAL at both the revsets and the basic workflow section. Overall the doc was vastly simplified.

docs/github.md Outdated Show resolved Hide resolved
@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch from 526d9f9 to 9c8e99b Compare December 28, 2022 19:28
docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch 4 times, most recently from d391b14 to ede6714 Compare December 30, 2022 14:07
Copy link
Member

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

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

I still have a lot of comments, but I think this is a good start. Thanks! Feel free to merge this as is, and then I'll probably go over it and send a follow-up PR later instead.

docs/github.md Outdated Show resolved Hide resolved
docs/github.md Outdated Show resolved Hide resolved
The document roughly describes some workflows, which help new users
to start with github.
@PhilipMetzger PhilipMetzger force-pushed the push-075ec4ff589b45a89ccf25098371e4ff branch from ede6714 to b8af620 Compare December 30, 2022 19:45
@PhilipMetzger PhilipMetzger enabled auto-merge (rebase) January 1, 2023 15:34
@PhilipMetzger PhilipMetzger merged commit 4835681 into jj-vcs:main Jan 1, 2023
@PhilipMetzger PhilipMetzger deleted the push-075ec4ff589b45a89ccf25098371e4ff branch January 1, 2023 15:36
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.

4 participants