Skip to content

Commit 4d7171e

Browse files
authored
Merge pull request #13 from DanielAvdar/docs-dbot
Docs dbot
2 parents d831a13 + 909edd1 commit 4d7171e

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed

.github/workflows/codecov.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ jobs:
2020
- run: uv python install 3.11
2121
- run: make
2222
- run: make coverage
23-
- uses: codecov/codecov-action@v4
23+
- uses: codecov/codecov-action@v5
2424
with:
2525
fail_ci_if_error: true
2626
verbose: true
27-
env:
28-
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
27+
token: ${{ secrets.CODECOV_TOKEN }}
28+
29+
2930
- uses: codecov/test-results-action@v1
3031
with:
3132
token: ${{ secrets.CODECOV_TOKEN }}

CONTRIBUTING.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,43 @@
11
# Contribution Guidelines
2-
Thank you for your interest in contributing to SchemArrow.
2+
3+
Thank you for your interest in contributing to "my-package". **Note:** Remember to update the package name if it
4+
changes.
35

46
## Prerequisites
5-
Before you start, make sure you have **poetry** installed on your machine. You can install it with this command:
7+
8+
Before you start, ensure that **uv** is installed on your machine. You can install it using the following command:
69

710
```bash
8-
pipx install uv
11+
pipx install uv
912
```
1013

11-
Also, make sure you have **forked** the repository and **cloned** your fork to your local machine.
14+
Additionally, make sure you have **forked** the repository and **cloned** your fork to your local machine.
1215

1316
## Setup
14-
To set up the project, navigate to the project directory and run these commands:
1517

16-
Install the project dependencies
18+
To set up the project, navigate to the project directory and execute the following command to install project
19+
dependencies:
20+
1721
```bash
18-
make
22+
make
1923
```
2024

21-
2225
## Testing and Code Checking
23-
To run the tests, use this command:
26+
27+
To run the tests, use the following command:
28+
29+
```bash
30+
make test
31+
```
32+
33+
To verify code style and formatting, use this command:
2434

2535
```bash
26-
make test
36+
make check
2737
```
2838

29-
To check the code style and formatting, use this command:
39+
To build the documentation, use this command:
3040

3141
```bash
32-
make check
42+
make doc
3343
```

0 commit comments

Comments
 (0)