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

Document possible workflows for subrepo PRs #4

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

perlpunk
Copy link
Collaborator

@perlpunk perlpunk commented Oct 23, 2020

Copy link
Member

@okurz okurz left a 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
Copy link
Member

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 :)

Copy link
Member

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.

Copy link
Collaborator Author

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.

Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

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.

Copy link
Collaborator Author

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"

@perlpunk
Copy link
Collaborator Author

perlpunk commented Sep 7, 2021

@okurz

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?

I would prefer no % in code blocks for easier copying into terminals :)

Those two wishes conflict with each other.
On the one hand you think this should be in the documentation of git-subrepo itself.
On the other hand, you want something to copy and paste.

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.

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.

3 participants