diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml index 451269c..6361e81 100644 --- a/.github/workflows/codecov.yml +++ b/.github/workflows/codecov.yml @@ -20,12 +20,13 @@ jobs: - run: uv python install 3.11 - run: make - run: make coverage - - uses: codecov/codecov-action@v4 + - uses: codecov/codecov-action@v5 with: fail_ci_if_error: true verbose: true - env: - CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + token: ${{ secrets.CODECOV_TOKEN }} + + - uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4279dd..8a0aaae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1,43 @@ # Contribution Guidelines -Thank you for your interest in contributing to SchemArrow. + +Thank you for your interest in contributing to "my-package". **Note:** Remember to update the package name if it +changes. ## Prerequisites -Before you start, make sure you have **poetry** installed on your machine. You can install it with this command: + +Before you start, ensure that **uv** is installed on your machine. You can install it using the following command: ```bash -pipx install uv + pipx install uv ``` -Also, make sure you have **forked** the repository and **cloned** your fork to your local machine. +Additionally, make sure you have **forked** the repository and **cloned** your fork to your local machine. ## Setup -To set up the project, navigate to the project directory and run these commands: -Install the project dependencies +To set up the project, navigate to the project directory and execute the following command to install project +dependencies: + ```bash -make + make ``` - ## Testing and Code Checking -To run the tests, use this command: + +To run the tests, use the following command: + +```bash + make test +``` + +To verify code style and formatting, use this command: ```bash -make test + make check ``` -To check the code style and formatting, use this command: +To build the documentation, use this command: ```bash -make check + make doc ```