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/technical: add an aspirational Git submodules doc #1411

Merged
merged 1 commit into from
Apr 3, 2023

Conversation

chooglen
Copy link
Contributor

@chooglen chooglen commented Mar 21, 2023

Add docs/technical/git-submodules.md to capture how we think about submodules, starting with (IMO) the least controversial parts:

  • Goals
  • A roadmap that provides incremental value

The doc isn't complete, we will add more details and discuss them as they come, e.g. there are no designs yet.

Contributes to #494

If applicable:

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

Copy link
Contributor

@PhilipMetzger PhilipMetzger left a comment

Choose a reason for hiding this comment

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

Here are some initial comments.

docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
@chooglen chooglen force-pushed the docs/submodules branch 2 times, most recently from 21bcfdb to 4d5e8c0 Compare March 21, 2023 23:52
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.

Thanks!

docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
@PhilipMetzger
Copy link
Contributor

Can we move the document from docs/technical to docs/design or similar? Then we'll have a place for other design docs, which exist but aren't implemented yet.

docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
docs/technical/git-submodules.md Outdated Show resolved Hide resolved
This document is meant to be a record of how we think about Git
submodules (and not a _current_ implementation of submodules). We will
fill it out incrementally as we get a clearer idea of what we want
submodules to look like.

As an initial version, I started with (IMO) the least controversial
points:

- We want to support most workflows Git submodules users are accustomed
  to.

- A roadmap that allows us to incrementally roll out Git submodule
  functionality (instead of having to boil the ocean).
@chooglen chooglen enabled auto-merge (rebase) April 3, 2023 19:55
@chooglen chooglen merged commit 707d822 into jj-vcs:main Apr 3, 2023
@chooglen chooglen deleted the docs/submodules branch April 3, 2023 20:02
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