-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #123 from bcgov/development
Merge to master
- Loading branch information
Showing
63 changed files
with
1,500 additions
and
2,283 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,13 @@ | ||
*Issue #:* | ||
https://github.com/bcgov/entity/issues/<Put the github issue number here> | ||
|
||
*Description of changes:* | ||
|
||
*API Code Review Checklist:* | ||
- #### Common | ||
- [ ] Proper naming conventions followed on variables, classes, definitions etc. | ||
- [ ] Proper logging levels are used in the code | ||
- #### REST | ||
- [ ] Endpoints follows agreed pattern and organized around resources | ||
- [ ] Conform to http semantics | ||
- [ ] Proper filtering and pagination is provided for large amounts of data | ||
- #### Code structure | ||
- [ ] Resources is used for request payload processing, validations, response codes, messages etc. | ||
- [ ] Service is used for business logic, 3rd party communication management. Maintains proper folder structure. | ||
- [ ] Model is used for database models. | ||
- [ ] Schemas is used for json schema | ||
- [ ] Util contains commonly used utility functions, constants | ||
- #### Test Cases | ||
- [ ] Unit test cases with happy and sad path for service, model (?) layers | ||
- [ ] Endpoints test cases with happy and sad path for resources | ||
- [ ] Mocking of services (mainly 3rd party dependencies) provided if applicable | ||
- [ ] Postman collection tests provided for endpoints with happy path | ||
- #### Code Quality | ||
- [ ] Proper code coverage for all the layers (percentage 80, 90 ?) | ||
- [ ] Linting | ||
- #### DB Migrations | ||
- [ ] Alembic is used to manage database migration. [Reference](https://github.com/bcgov/namex/blob/master/docs/database.md) | ||
*Checklist:* | ||
I confirm that below checklist items are addressed in this pull request; (check the boxes applicable) | ||
- [ ] No lint errors | ||
- [ ] No test case failures and proper coverage for all modules/classes | ||
- [ ] Updated the deployment configs for new environment variable(s) | ||
- [ ] Updated the postman collection in entity repository (https://github.com/bcgov/entity/tree/master/api-e2e/postman) for e2e tests | ||
|
||
|
||
*UI Code Review Checklist:* | ||
|
||
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the namex license (Apache 2.0). | ||
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the sbc-pay license (Apache 2.0). |
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
Oops, something went wrong.