Skip to content

Commit bc037b9

Browse files
committed
docs: move CONTRIBUTING.md to docs/contributing.md
1 parent 536b253 commit bc037b9

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

CONTRIBUTING.md renamed to docs/contributing.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document provides guidelines and instructions for contributing to the proje
1010

1111
2. **Submit Pull Requests**: For code contributions, fork the repository, make your changes, and submit a pull request.
1212

13-
3. **Follow Coding Standards**: We use Ruff for linting and formatting, and pyright/basedpyright for type checking. Make sure your code passes all checks.
13+
3. **Follow Coding Standards**: We use Ruff for linting and formatting, and ty for type checking. Make sure your code passes all checks.
1414

1515
4. **Write Tests**: For new features or bug fixes, please include tests to validate your changes.
1616

@@ -24,23 +24,23 @@ This section describes how to set up the **recommended** development environment
2424

2525
1. Download the repository:
2626

27-
```sh
28-
git clone https://github.com/S1M0N38/balatrollm.git
29-
cd balatrollm
30-
```
27+
```sh
28+
git clone https://github.com/S1M0N38/balatrollm.git
29+
cd balatrollm
30+
```
3131

3232
2. Create environment:
3333

34-
```sh
35-
uv sync --all-extras
36-
```
34+
```sh
35+
uv sync --all-extras
36+
```
3737

3838
3. Set up environment variables (if your project uses them):
3939

40-
```sh
41-
cp .envrc.example .envrc
42-
# And modify the .envrc file with your settings
43-
```
40+
```sh
41+
cp .envrc.example .envrc
42+
# And modify the .envrc file with your settings
43+
```
4444

4545
The environment setup is now ready to use. Every time you are working on the project, you can activate the environment by running:
4646

0 commit comments

Comments
 (0)