This repository was archived by the owner on Apr 3, 2018. It is now read-only.
docs: Developer: must develop/test in main repo#653
Closed
grahamwhaley wants to merge 1 commit intocontainers:masterfrom
Closed
docs: Developer: must develop/test in main repo#653grahamwhaley wants to merge 1 commit intocontainers:masterfrom
grahamwhaley wants to merge 1 commit intocontainers:masterfrom
Conversation
jodh-intel
reviewed
Mar 2, 2018
documentation/Developers.md
Outdated
|
|
||
| **Note:** As `virtcontainers` contains and references its own | ||
| [sub packages](https://github.com/containers/virtcontainers/tree/master/pkg), | ||
| it will **not** build or past its tests in your user fork repo (as the |
documentation/Developers.md
Outdated
|
|
||
| In order to develop and submit PRs for `virtcontainers`, the easist method is to: | ||
|
|
||
| - create a user fork on github. |
Collaborator
There was a problem hiding this comment.
I'd capitalise the first words in all these bullets.
documentation/Developers.md
Outdated
|
|
||
| ``` | ||
| # make check | ||
| # CI=true make check |
Collaborator
There was a problem hiding this comment.
Could you change all the prompts to "$ " as "# " reads as "OMG we're running as root dude!" to me ;)
sboeuf
reviewed
Mar 2, 2018
documentation/Developers.md
Outdated
| [pkg references](https://github.com/containers/virtcontainers/blob/master/cni.go#L25) | ||
| will still reference the main repo, and this results in golang type clashes etc.). | ||
|
|
||
| In order to develop and submit PRs for `virtcontainers`, the easist method is to: |
documentation/Developers.md
Outdated
|
|
||
| In order to develop and submit PRs for `virtcontainers`, the easist method is to: | ||
|
|
||
| - create a user fork on github. |
You cannot build and test in a repo fork, as the sub-pkg references do not move with the fork, and we fail due to type difference failures. Add details on how to add your user fork as a remote to the main repo so you can develop/PR. Also update details on installing required components into /tmp, and the inherent weakness of that. Note you need 'CI=true' to usefully run `make check`. Fixes: containers#642 Signed-off-by: Graham whaley <graham.whaley@intel.com>
grahamwhaley
force-pushed
the
20180302_devdoc_branches
branch
from
bf1ac20 to
c3b142d
Compare
Contributor
Author
|
@jodh-intel - updated, pushed. |
Collaborator
|
The only potential issue is the lgtm
|
devimc
reviewed
Mar 5, 2018
| In order to develop and submit PRs for `virtcontainers`, the easiest method is to: | ||
|
|
||
| - Create a user fork on github. | ||
| - Clone the main repo to your development machine (with `go get`) |
Contributor
Author
There was a problem hiding this comment.
well, it was not an explicit $ got get -d -u <blah> instruction (similarly, did not call out how to clone repos or add remotes). So, nah, I think not.
amshinde
reviewed
Mar 5, 2018
|
|
||
| # Cloning and Submitting | ||
|
|
||
| If you are just builiding `virtcontainers`, then you can simply clone the main repository |
| from https://github.com/containers/virtcontainers. | ||
|
|
||
| If you wish to develop `virtcontainers`, you should fork the project on github under your | ||
| user. |
Collaborator
There was a problem hiding this comment.
under your user account maybe?
Collaborator
|
@grahamwhaley Need to be closed and moved to https://github.com/kata-containers/runtime/virtcontainers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You cannot build and test in a repo fork, as the sub-pkg
references do not move with the fork, and we fail due to
type difference failures.
Add details on how to add your user fork as a remote to the
main repo so you can develop/PR.
Also update details on installing required components into
/tmp, and the inherent weakness of that.
Note you need 'CI=true' to usefully run
make check.Fixes: #642
Signed-off-by: Graham whaley graham.whaley@intel.com