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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the way we interact with git #1735

Merged
merged 4 commits into from Oct 9, 2018

Conversation

4 participants
@smashwilson
Member

smashwilson commented Oct 8, 2018

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 馃

smashwilson added some commits Oct 8, 2018

@coveralls

This comment has been minimized.

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

@vanessayuenn

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?

Show resolved Hide resolved docs/git-interactions.md
@smashwilson

This comment has been minimized.

Member

smashwilson commented Oct 8, 2018

[..] 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

This comment has been minimized.

Contributor

vanessayuenn commented Oct 8, 2018

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

@kuychaco

Looks good to me! Thanks for writing this up @smashwilson 馃檱鈥嶁檧锔

@smashwilson

This comment has been minimized.

Member

smashwilson commented Oct 9, 2018

Thanks for reading it over 馃檱

@smashwilson smashwilson merged commit 44d1273 into master Oct 9, 2018

6 checks passed

ci/circleci: beta Your tests passed on CircleCI!
Details
ci/circleci: dev Your tests passed on CircleCI!
Details
ci/circleci: stable Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage decreased (-0.2%) to 81.784%
Details

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 Oct 9, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment