docs: add working with gerrit section #7396
Conversation
DanieleSassoli
changed the base branch from
main
to
aseipp/push-uytvkxyqyspn
DanieleSassoli
changed the title
|
This in general looks good to me, but your patch is failing the CI because the commit title not the PR title should be |
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
from
586bc96 to
9342158
Compare
There was a problem hiding this comment.
Generally looks pretty good, but 3 main focus areas:
- User guides should focus on how a user interacts with something, rather than the technical details of how it works under the hood
- You make a lot of assumptions about the user's workflow, in particular
@-vs@. JJ does not distinguish these. You're welcome to use@-in your examples, but we should avoid making assumptions and saying things like "@-is the last non-empty commit" - One thing it appears you've missed in how the command works is that when you push to gerrit, you are pushing not just a single commit, but a stack of changes. So your usage of
trunk()..@-are equivalent to@-
|
I've updated the docstrings for the commands in the original pr, since the behaviour around stacked commits was very non-obvious. |
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
5 times, most recently
from
260d695 to
42e9d3e
Compare
|
I must have messed up the change trying to rebase it on top of the latest branch, apologies, fixing it now. |
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
2 times, most recently
from
b256a97 to
6916452
Compare
|
Ah, I just noticed that you appear to have uploaded two commits here. IIRC when working with jj we require that in a PR, each commit be useful on its own, rather than just the response to previous feedback, so I think you should squash your two commits and reupload. |
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
from
6916452 to
6dd75fa
Compare
|
@matts1 apologies, missed it when pushing. Thanks for pointing it out. |
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
from
6dd75fa to
9f0836c
Compare
DanieleSassoli
changed the base branch from
aseipp/push-uytvkxyqyspn
to
main
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
from
9f0836c to
a431457
Compare
Currently there are instructions on how to setup jj to work with GitHub, but not Gerrit, which seems to be very popular with the jj community. Add a gerrit.md file to help users discover the jj gerrit subcommand.
DanieleSassoli
force-pushed
the
add_gerrit_docs
branch
from
a431457 to
6ebe9f8
Compare
6 participants
This PR depends on @matts1 change that addst the Gerrit upload
command.
I should add, I'm very new to JJ and this is my first contribution.
Please let me know if I did anything wrong.
Checklist
If applicable:
CHANGELOG.mdREADME.md,docs/,demos/)cli/src/config-schema.json)