Skip to content

Commit

Permalink
Merge branch 'main' into feature/implement-unit-testing
Browse files Browse the repository at this point in the history
  • Loading branch information
abeltavares authored and Abel Tavares committed Feb 10, 2024
2 parents 86be005 + 4958ec5 commit 28f16e6
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 432 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The pipeline follows object-oriented programming principles to ensure modularity

Unit testing is implemented throughout the workflow to ensure the reliability and efficiency of the pipeline. These tests validate the functionality of each component and help identify any potential issues or bugs.


## Project Components


Expand Down Expand Up @@ -184,7 +183,6 @@ graph TD;
airflow trigger_dag data_collection_storage_crypto
```


## Setting up Pre-commit Hooks (Developer Setup)

To ensure code quality and run unit tests before committing changes, MarketTrackPipe uses [pre-commit](https://pre-commit.com/) hooks. Follow these steps to set it up:
Expand All @@ -200,9 +198,10 @@ To ensure code quality and run unit tests before committing changes, MarketTrack
```bash
pre-commit install
```

This will install the pre-commit hook into your git repository.
<br>

3. Now, every time you commit changes, pre-commit will automatically run unit tests to ensure code quality. Additionally, these tests are also executed in a GitHub Actions workflow on every pull request to the repository.

## Usage
Expand Down
Empty file added core/__init__.py
Empty file.
Loading

0 comments on commit 28f16e6

Please sign in to comment.