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

Initialise git repo #1670

Closed
1 of 4 tasks
nataliecarey opened this issue Oct 11, 2022 · 3 comments · Fixed by #1860
Closed
1 of 4 tasks

Initialise git repo #1670

nataliecarey opened this issue Oct 11, 2022 · 3 comments · Fixed by #1860
Assignees
Labels
🕔 Days A few unknowns, but we roughly know what’s involved.

Comments

@nataliecarey
Copy link
Contributor

nataliecarey commented Oct 11, 2022

What

When we create a kit for a user we don't currently initialise a git repository, that means that most of our users will need to do that for themselves. They're likely to do so after making some of their own changes which will make it harder for them to look back and see what changes they made vs the kit that was generated for them.

Why

It will save users from needing to remember to initialise it themselves, this is something I believe most users would benefit from and there is very little downside for users who don't use the functionality

Who needs to work on this

  • Developer

Who needs to review this

  • Developer

Done when

  • Git is initialised by default with an initial commit
  • Users can opt-out of git with a flag like --version-control=none
  • If user doesn't have git installed create still happens successfully
  • If user has already initialised git repo create still happens successfully, but without commit
@ruthhammond ruthhammond added 🕔 Days A few unknowns, but we roughly know what’s involved. and removed awaiting triage labels Oct 18, 2022
@ruthhammond
Copy link

Questions

  • Does this need to be documented? If yes, where should it be documented?
  • If they don't have Git installed, should we warn them that they don't?

@ruthhammond
Copy link

Final decision needed whether this is for v13 or later.
Not entirely sure whether this is a breaking change.

@ruthhammond
Copy link

Would this be expected behaviour? Apparently some other products do this e.g. React. @nataliecarey please document some examples of where this happens

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕔 Days A few unknowns, but we roughly know what’s involved.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants