Skip to content

Commit

Permalink
add images
Browse files Browse the repository at this point in the history
  • Loading branch information
Aldrian Harjati committed Oct 10, 2023
1 parent ef614f1 commit e43bf72
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Development standard practice
- [Unit Test](./src/tests/test_check_functions.py)
- Check definitions' name should be set to validation ID.
- Example: "denial_reasons. enum_value_conflict"
![Validation ID](validation_id.png)
![Validation ID](images/validation_id.png)
- Check new added lines are formatted correctly.

## Installing Dependencies
Expand Down Expand Up @@ -398,7 +398,9 @@ All done! ✨ 🍰 ✨
- Enter `Dev Containers: Rebuild and Reopen in Container`. VS Code will open a new window and you'll see a status message towards the bottom right of your screen that the container is building and attaching.
- This will take a few minutes the first time because Docker needs to build the container without a build cache.
- You may receive a notification that VS Code wants to perform a reload because some extensions could not load. Sometimes this happens because extensions are loaded in conflicting orders and dependencies are not satisfied.
- If using VS Code, validator can be executed by running `main.py` within a Dev Container. To run `main.py`, you can run these commands in VSCode terminal.
- Unit tests can be run through VS Code Test.
![VS Code Test](images/vscode_test.png)
- Validator can be executed by running `main.py` within a Dev Container. To run `main.py`, you can run these commands in VSCode terminal.

```sh
# Test validating the "good" file
Expand All @@ -415,8 +417,8 @@ python src/validator/main.py src/tests/data/sbl-validations-fail.csv

## Code Coverage

[![Coverage badge](https://github.com/cfpb/regtech-data-validator/raw/python-coverage-comment-action-data/badge.svg)](https://github.com/cfpb/regtech-data-validator/tree/python-coverage-comment-action-data)
Complete coverage details can be found under [`python-coverage-comment-action-data` branch](https://github.com/cfpb/regtech-data-validator/tree/python-coverage-comment-action-data)
- Current overall coverage: [![Coverage badge](https://github.com/cfpb/regtech-data-validator/raw/python-coverage-comment-action-data/badge.svg)](https://github.com/cfpb/regtech-data-validator/tree/python-coverage-comment-action-data)
- Complete coverage details can be found in ( [`python-coverage-comment-action-data` branch](https://github.com/cfpb/regtech-data-validator/tree/python-coverage-comment-action-data) )

## Contributing

Expand Down
File renamed without changes
Binary file added images/vscode_test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e43bf72

Please sign in to comment.