Requirement to ensure all functional changes are reflected in the API #80
Conversation
This file contains 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
jeff-matthews
added
the
major-update
|
@sivaschenko, thanks for the PR. Let me know when you're ready for a review. |
|
@sivaschenko any changes in the status of this PR? |
|
@keharper the changes are still being reviewed by managers and product owners. I would expect it to be ready for merge soon. |
fascinosum
reviewed
Oct 6, 2023
| - Functionality exposed in the admin panel must be covered with api-functional tests | ||
| - Changes affecting code API must be covered by integration tests | ||
|
|
||
| Unit test coverage is generally not recommended and should be applied only for testing parts of code containing complex calculations in isolation. |
There was a problem hiding this comment.
It is well covered in the https://github.com/AdobeDocs/commerce-contributor/blob/21ca8122d40165d28d51097c57a80ee1beb88108/src/pages/guides/code-contributions/automated-tests.md#unit-tests
this statement is excessive
fascinosum
reviewed
Oct 6, 2023
| In order to ensure the changes are reflected in the API: | ||
|
|
||
| - Changes of functionality must be covered by api-functional tests | ||
| - API coverage must be added if the functionality that is changed or introduced is not covered by API |
There was a problem hiding this comment.
What criteria should prompt the introduction of a new API? Creating a new API is a complex and time-consuming process. This statement requires clarification or modification
Suggested change
| - API coverage must be added if the functionality that is changed or introduced is not covered by API | |
| - If the functionality is changed and not covered by the existing API, API coverage should be added. | |
| - API coverage must be added for all new functionalities |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose of this pull request
This pull request (PR) introduced a requirement to ensure all functional changes are reflected in the API
Affected pages