Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Document the way we interact with git #1735

Merged
merged 4 commits into from
Oct 9, 2018
Merged

Document the way we interact with git #1735

merged 4 commits into from
Oct 9, 2018

Conversation

smashwilson
Copy link
Contributor

Most interestingly, the way we intercept various kinds of credential prompts, and the differences between the different layers of the interface (what lives in GitShellOutStrategy vs. Repository and its states).

cc @sguthals @kuychaco @annthurium @vanessayuenn

🦄 r e n d e r e d 🦄

@coveralls
Copy link

coveralls commented Oct 8, 2018

Coverage Status

Coverage decreased (-0.8%) to 81.093% when pulling 19856cd on aw/git-docs into 2466c36 on master.

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from In Progress 🔧 to QA Review 🔬 Oct 8, 2018
Copy link
Contributor

@vanessayuenn vanessayuenn left a comment

Choose a reason for hiding this comment

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

This is a super informative & helpful doc! Thanks for writing this! ✨

A small comment: although I see how the sections under Repository is closely related to the git interactions, it's probably important and big enough of a topic to warrant its own doc?

docs/git-interactions.md Show resolved Hide resolved
@smashwilson
Copy link
Contributor Author

[..] it's probably important and big enough of a topic to warrant its own doc [..]

Do you mean the Repository states description? There is a bit more information about that (like a state transition diagram) in a README in the lib/models/repository-states directory. I could link that here maybe 🤔

@vanessayuenn
Copy link
Contributor

Oh yes I didn't realize we have this doc outside of docs/. Yea I think a link would help discoverability.

Copy link
Contributor

@kuychaco kuychaco left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for writing this up @smashwilson 🙇‍♀️

@smashwilson
Copy link
Contributor Author

Thanks for reading it over 🙇

@smashwilson smashwilson merged commit 44d1273 into master Oct 9, 2018
Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from QA Review 🔬 to Merged ☑️ Oct 9, 2018
@smashwilson smashwilson deleted the aw/git-docs branch October 9, 2018 16:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants