Skip to content

docs: jj commands table #6543

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

saichandangorli1
Copy link

@saichandangorli1 saichandangorli1 commented May 15, 2025

This commit creates the jj-commands-table.md file, containing a formatted table of frequently used jj commands. The table includes command syntax, descriptions, and practical examples to aid in understanding and using jj.

I came across your work with jj and I'd really like to contribute and help you out with it.

preview : jj-commands-table.pdf

@saichandangorli1 saichandangorli1 requested a review from a team as a code owner May 15, 2025 07:34
@PhilipMetzger
Copy link
Contributor

per our contributing guidelines this should be prefixed with docs: <title> (https://github.com/jj-vcs/jj/blob/main/docs/contributing.md#commit-guidelines), also mind adding it to the website with a mkdocs.yml entry?

@saichandangorli1
Copy link
Author

per our contributing guidelines this should be prefixed with docs: <title> (https://github.com/jj-vcs/jj/blob/main/docs/contributing.md#commit-guidelines), also mind adding it to the website with a mkdocs.yml entry?

Thanks for the feedback! I've already updated the commit message with the docs: prefix and added the entry to mkdocs.yml

@saichandangorli1 saichandangorli1 changed the title Create jj-commands-table.md docs: Create jj commands table May 15, 2025
@saichandangorli1 saichandangorli1 changed the title docs: Create jj commands table docs: jj commands table May 15, 2025
@saichandangorli1 saichandangorli1 changed the title docs: jj commands table docs: jj commands table May 15, 2025
@PhilipMetzger
Copy link
Contributor

to land your first contribution you now need to squash it all into one commit and rebase instead of merging trunk()

@saichandangorli1
Copy link
Author

to land your first contribution you now need to squash it all into one commit and rebase instead of merging trunk()

Got it! I'm currently trying to squash my commits as you suggested, but I've run into a bit of an issue on my end. Would you be able to offer some guidance? Any help would be greatly appreciated!

@PhilipMetzger
Copy link
Contributor

PhilipMetzger commented May 15, 2025

You already managed to squash the relevant commits into one, now the only thing you need to do is rebase instead of merging. With jj 1, it should be easy, otherwise this video should help.

Footnotes

  1. its jj abandon <first-merge-commit>::, jj git fetch, jj rebase -r <docs-rev> -d 'trunk()

@saichandangorli1
Copy link
Author

Thanks for the video link – I've already checked it out
I'm just a little unsure if I've got all the changes you mentioned quite right yet. I've also received another pull request suggestion. Should I go ahead and create a new pull request, or can you already see on your end if the changes you suggested earlier are reflected?

@PhilipMetzger
Copy link
Contributor

Should I go ahead and create a new pull request, or can you already see on your end if the changes you suggested earlier are reflected?

I cannot see your now "local state" yet, as you haven't repushed the branch yet. Also you'll need to force push with Git since it will overwrite external commits.

I've also received another pull request suggestion.

What do you mean by that? As long as you follow the commit guidelines you can have as many open PRs as you want.

Should I go ahead and create a new pull request,

Not necessary if you fix this without messing up.

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.

2 participants