Skip to content

doc: add developer guidelines#621

Merged
zhouhao3 merged 1 commit intoopencontainers:masterfrom
kinvolk-archives:alban/devel_guidelines
Apr 19, 2018
Merged

doc: add developer guidelines#621
zhouhao3 merged 1 commit intoopencontainers:masterfrom
kinvolk-archives:alban/devel_guidelines

Conversation

@alban
Copy link
Copy Markdown
Contributor

@alban alban commented Apr 13, 2018

It's not obvious how the TAP output is displayed and the meaning of the
exit value.

This documentation is meant to be for developers who want to add a new
validation test.

Signed-off-by: Alban Crequy alban@kinvolk.io

Copy link
Copy Markdown
Contributor

@wking wking left a comment

Choose a reason for hiding this comment

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

Two nits, otherwise this looks good to me.


### Exit status

When the runtime fails a test, the TAP output indicates so with "not ok" but the exit status of test program normally remain 0.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"remain" -> "remains".


When the runtime fails a test, the TAP output indicates so with "not ok" but the exit status of test program normally remain 0.
A non-zero exit status indicates a problem in the test program rather than in the runtime.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No need for this trailing empty line.

It's not obvious how the TAP output is displayed and the meaning of the
exit value.

This documentation is meant to be for developers who want to add a new
validation test.

Signed-off-by: Alban Crequy <alban@kinvolk.io>
@alban alban force-pushed the alban/devel_guidelines branch from 1e5556b to cc8ab2e Compare April 17, 2018 14:02
@alban
Copy link
Copy Markdown
Contributor Author

alban commented Apr 17, 2018

@wking thanks for the review! I updated the commit.

@zhouhao3
Copy link
Copy Markdown

zhouhao3 commented Apr 19, 2018

LGTM

Approved with PullApprove

@zhouhao3 zhouhao3 merged commit d5abe1a into opencontainers:master Apr 19, 2018
@dongsupark dongsupark deleted the alban/devel_guidelines branch April 19, 2018 13:23
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