microsoft/qlib

Refine Qlib's code style reported by pylint and flake8

Open

#1,007 opened on Mar 24, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (14,037 stars) (2,431 forks)batch import
enhancementgood first issue

Description

🌟 Feature Description

Motivation

Qlib has integrated pylint and flake8 to automatically detect the problem of coding style

But some errors are not fixed due to the limited bandwidth of the maintainers. It will be very helpful if the community would like to contribute to refine them :)

image

Alternatives

Additional Notes

Contributor guide

Tech stack
python
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Pythonknowledge of pylint/flake8
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Run pylint and flake8 on the Qlib codebase as configured in .github/workflows/test.yml to see all linting errors. The issue provides a screenshot of some errors. Focus on fixing the reported issues, likely involving code style adjustments like formatting, unused imports, or naming conventions. After fixing, ensure the linters pass locally.