Skip to content

added jj docs #63

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.

Sign up for GitHub

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

Merged
clsource merged 1 commit into from
Mar 9, 2025
Merged

added jj docs #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 0 additions & 40 deletions docs/modules/developer/pages/dev_environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,43 +130,3 @@ Debian separates some needed libraries such as ssl. If there are some problems y
----
$ sudo apt install -y erlang-ssl
----

= Using JJ

We recommend using JJ as your Version Control System (VCS) for this project. JJ is git-compatible, so from the perspective of other tools, there’s no noticeable difference between using JJ or Git. However, JJ introduces a more intuitive and streamlined workflow.

== Why Use JJ?


- Git Compatibility: JJ seamlessly integrates with Git, allowing you to use both tools interchangeably.

- Simplified Model: JJ replaces Git’s commit-based model with `changes`, which is how a commit evolves over time, making it easier to manage and reason about changes.

- Easier History Rewriting: JJ simplifies operations like rebase, amend, and reordering changes, making it more straightforward to rewrite history when needed, and leading to a cleaner history.

== Learning Resources

- https://jj-vcs.github.io/jj/latest/tutorial/[JJ Tutorial]: Get started with JJ using the official tutorial

- https://jj-vcs.github.io/jj/latest/git-comparison/[Git Comparison]: Understand the key differences between Git and JJ with the Git comparison guide

== Key Features

- Changes: Changes in JJ are tracked as changes instead of commits. This simplifies the history and makes it easier to manage.

- Branchless Workflow: JJ encourages a more linear workflow by minimizing the need for branches, which can reduce complexity.

- Automatic changes: Every operation in JJ creates a new change, ensuring a clear and consistent history.


== Getting Started

To start using JJ with this project, install JJ by following the https://jj-vcs.github.io/jj/latest/install-and-setup/[installation instructions]. Then use JJ commands to interact with the repository. For example:

- jj new: Create a new change.

- jj split: Split the changes in a change

- jj log: View the project’s history.

- jj rebase: Reorder or edit changes.
10 changes: 6 additions & 4 deletions docs/modules/developer/pages/jj.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ JJ is git-compatible, so from the perspective of other tools, there’s no notic

To start using JJ with this project, install JJ by following the https://jj-vcs.github.io/jj/latest/install-and-setup/[installation instructions]. Then use JJ commands to interact with the repository. For example:

- jj new: Create a new change.
- `jj new`: Create a new change.

- jj split: Split the changes in a change
- `jj split`: Split the changes in a change

- jj log: View the project’s history.
- `jj log`: View the project’s history.

- jj rebase: Reorder or edit changes.
- `jj rebase`: Reorder or edit changes.

On first usage you may need to run `jj git init --colocate` to initialize a new Jujutsu working environment.
Loading