Skip to content

Commit

Permalink
docs: update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daxartio committed Jul 15, 2023
1 parent dd71539 commit 5b7730b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
23 changes: 20 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
1. Сделайте [fork](https://github.com/Tinkoff/invest-python/fork) проекта
2. Склонируйте репозиторий на свой локальный компьютер
```bash
git clone https://github.com/Tinkoff/invest-python.git
git clone https://github.com/username/invest-python.git
```
> Вы должны использовать свой username вместо `username`
3. Создайте новую ветку для ваших изменений
```bash
git checkout -b branch_name
Expand Down Expand Up @@ -66,15 +67,31 @@ Body и Footer можно указать по желанию.
Для работы с проектом рекомендуем использовать [poetry](https://pypi.org/project/poetry/).
Также рекомендуем использовать таск раннер make.
Также рекомендуем использовать таск раннер make. Все команды описаны в Makefile. Вы можете их скопировать и запускать напрямую.
## Установка зависимостей
```
pip install poetry
make install-poetry
make install
```
### Виртуальное окружение
По умолчанию, poetry создает виртуальное окружение в директории `~/.cache/pypoetry/virtualenvs/`. Чтобы создавать виртуальное окружение в директории проекта, выполните команду:
```
poetry config virtualenvs.in-project true
```
Вы можете сами создать виртуальное окружение в директории проекта:
```
python -m venv .venv
```
poetry будет использовать его.
### Запуск тестов
```
Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ site_name: Tinkoff Invest
site_url: https://tinkoff.github.io/invest-python/
site_description: 'Tinkoff Invest Python'

repo_name: 'invest-python'
repo_name: 'Tinkoff/invest-python'
repo_url: 'https://github.com/Tinkoff/invest-python'
edit_uri: "edit/main/docs/"

Expand Down Expand Up @@ -47,3 +47,5 @@ markdown_extensions:
- codehilite
- pymdownx.superfences
- tables
- pymdownx.tasklist:
custom_checkbox: true

0 comments on commit 5b7730b

Please sign in to comment.