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

Enhance API-Testing-Guidelines.md #203

Merged
merged 14 commits into from
Jun 17, 2024

Conversation

jlurien
Copy link
Contributor

@jlurien jlurien commented May 15, 2024

What type of PR is this?

  • documentation

What this PR does / why we need it:

Enhances API testing guidelines with much more details and explanations. Initial version was too basic to assure consistent and coherent testing plans.

Which issue(s) this PR fixes:

Fixes #158

Special notes for reviewers:

This is a first draft following proposal and initial feedback in #158.

Changelog input

* Enhancement of API-Testing-Guidelines

documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
jlurien and others added 2 commits May 21, 2024 17:36
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Proposal updated with comments and feedback after dedicated session on May 16th.

- Tests coverage section moved to to the top, merging legacy section "Test Cases contribution for APIs".
- Added distinction between basic and enhanced test plan, to be aligned with Release Management proposal. There is no proper definition of what is basic or enhanced, so I suggested some initial test.
- Added explicitly that environment variables may be kept in a separated file. We should enhance this part with more details and a suggested template.
@jlurien
Copy link
Contributor Author

jlurien commented May 24, 2024

In the latter commit:

Proposal updated with comments and feedback after dedicated session on May 16th.

  • Tests coverage section moved to to the top, merging legacy section "Test Cases contribution for APIs".
  • Added distinction between basic and enhanced test plan, to be aligned with Release Management proposal. There is no proper definition of what is basic or enhanced, so I suggested some initial text.
  • Added explicitly that environment variables may be kept in a separated file. We should enhance this part with more details and a suggested template.

Please review these changes.

@jlurien jlurien requested review from PedroDiez and rartych May 24, 2024 08:33
Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
documentation/API-Testing-Guidelines.md Outdated Show resolved Hide resolved
jlurien and others added 6 commits June 11, 2024 13:36
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
PedroDiez
PedroDiez previously approved these changes Jun 11, 2024
Copy link
Collaborator

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

Some minor editorials to be reviewed
Fine at content level

LGTM in advance

@jlurien
Copy link
Contributor Author

jlurien commented Jun 11, 2024

I think I have incorporated all suggestions and feedback, please double check

PedroDiez
PedroDiez previously approved these changes Jun 11, 2024
Copy link
Collaborator

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

LGTM

@mdomale
Copy link

mdomale commented Jun 12, 2024

@jlurien Except above 1 comment PR looks fine to us .

Fix feature filenames examples
@jlurien
Copy link
Contributor Author

jlurien commented Jun 14, 2024

Final comments addressed. Thanks for the feedback and corrections.

Copy link
Collaborator

@rartych rartych left a comment

Choose a reason for hiding this comment

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

LGTM

@rartych rartych requested a review from PedroDiez June 14, 2024 14:08
Copy link
Collaborator

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

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

LGTM

@mdomale
Copy link

mdomale commented Jun 15, 2024

@jlurien Thanks for accommodating comments .LGTM now cc @akoshunyadi @shilpa-padgaonkar

Copy link

@mdomale mdomale left a comment

Choose a reason for hiding this comment

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

LGTM thanks

Copy link
Collaborator

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Enhancement of the Testing Guidelines
5 participants