Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show version log for changes on rules #11369

Open
inoa-jboliveira opened this issue May 11, 2024 · 1 comment
Open

Show version log for changes on rules #11369

inoa-jboliveira opened this issue May 11, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation needs-design Needs further design before implementation

Comments

@inoa-jboliveira
Copy link

Context: Discussion #11367

The idea is that each rule should have a history or log of when it was added as preview, when it became stable and when it had changes in behavior. Also the version if it became deprecated or removed.

Example:

Rule FOO123
v0.1.2 - Added as experimental
v0.2.7 - Behavior changed for classes with letter J
v0.3.0 - Rule became stable
v0.3.2 - Rule deprecated in favor of BAR999
v0.4.0 - Rule removed

This page https://docs.astral.sh/ruff/rules/ could show which minor version the rule became stable if it is stable or the patch version if it is still experimental:

Code Name Message Availability
FOO201 class-comparison-one Checks when class is compared to function 0.2 ✔️ 🛠️
FOO202 class-comparison-two Checks when class is compared to method 0.3.4 🧪 🛠️

In our application we have preview = true because we are moving quite fast with ruff iterations and even experimental ruff rules are usually much better than relying on other linters. Having this would help a lot on us prioritizing rules that been experimental for longer or that have been added on versions that our devs have installed already.

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label May 11, 2024
@zanieb zanieb added the needs-design Needs further design before implementation label May 11, 2024
@zanieb
Copy link
Member

zanieb commented May 11, 2024

We'd need to design internal tooling to make this possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs-design Needs further design before implementation
Projects
None yet
Development

No branches or pull requests

3 participants