-
Notifications
You must be signed in to change notification settings - Fork 9
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
Document possible workflows for subrepo PRs #4
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice description but I wonder if we need these details in os-autoinst-common. Maybe this is something that should be upstream and we just reference it here?
|
||
Prepare: | ||
|
||
% git checkout -b feature1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer no %
in code blocks for easier copying into terminals :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The old-school %
prompt is so far being used everywhere. I'd suggest to change this separately.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
%
is the default zsh prompt.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regardless which shell you use and what prompt character it uses, if it is $
for a user-bash, #
for a root-bash, %
in zsh or >
in tcsh, please use shell code sections without prefixes for easier copying. Compare to https://github.com/os-autoinst/scripts/blob/master/README.md#openqa-label-known-issues
README.md
Outdated
@@ -57,6 +57,76 @@ them and then do: | |||
|
|||
% git subrepo push ext/os-autoinst-common | |||
|
|||
### Possible Workflows | |||
|
|||
One can make changes to the subrepo directly from the host repo, but there are |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "host repo" has not been defined properly. I would vote for "superrepo" which would be the direct opposite of "subrepo". Also see https://answers.yahoo.com/question/index?qid=20080706235630AA5Eecl&guccounter=1&guce_referrer=aHR0cHM6Ly93d3cuZWNvc2lhLm9yZy9zZWFyY2g_cT1vcHBvc2l0ZStvZislMjJzdWIlMjImYWRkb249ZmlyZWZveCZhZGRvbnZlcnNpb249NC4wLjQ&guce_referrer_sig=AQAAAAGVqiCbnGrZSpgQowy4dQo-UPpqg7AmfBRUp8LnkXyRbxt26biINCQkoqkmE0TxoY7CBlDW86k71g1o4FhAFRKL_fTdLCG8CFOiDcFmxfZBf2t9mWwKrence5DOUraIhf0Cu_nqsVJsI1XrX7uM4Ijr3fj_dx2zejx5ik-Mc4Nb
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest to change "top repo" in the previous section for consistency.
"Project repo" would work for me, too. All of those convey the point as far as I'm concerned.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it to "top repo"
Those two wishes conflict with each other. But the more generic, the less you can copy and paste. This is a documentation of how we should use git-subrepo. It is not a documentation on how git-subrepo should be used by everyone. People have different workflows. |
See https://github.com/perlpunk/os-autoinst-common/blob/readme/README.md Section "Possible Workflows"