Skip to content

Commit

Permalink
Merge branch 'fix/update-contributing-add-info-about-generate-pyproje…
Browse files Browse the repository at this point in the history
…ct' into 'main'

Add info about pyproject.toml generation in contributing.md

See merge request ai-lab-pmo/mltools/recsys/RePlay!246
  • Loading branch information
OnlyDeniko committed Jan 31, 2025
2 parents c93bc22 + 22d58ca commit bb1178a
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,28 @@ If you are installing from the source, you will need Python 3.8.1-3.11.
Note that during this step, updated poetry.lock file do not need to be copied anywhere.
6. **optional**: Generate pyproject.toml file
- If you want to get default pyproject.toml file, then get it from projects/pyproject.toml.template, using command:
```bash
./poetry_wrapper.sh --generate
```
or
```bash
./poetry_wrapper.sh --experimental --generate
```
For the experimental module
- This will allow you to use standard development configurations (including the linter and formatter needed to match the code style)
## Style Guide
We follow [the standard python PEP8](https://www.python.org/dev/peps/pep-0008/) conventions for style.
### Automated code checking
First of all, make sure that you have the correct style configuration set up.
You can just get pyproject.toml file from step 6, to start using linters and formatters
In order to automate checking of the code quality, please run:
```bash
Expand Down

0 comments on commit bb1178a

Please sign in to comment.