openedx / openedx/openedx-platform
Cap the number of lint-amnesty comments
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
People are constantly adding:
# lint-amnesty, pylint: disable=xyz
instead of just:
# pylint: disable=xyz
because they don't realize that lint-amnesty has a special meaning (that is: pylint violations which were grandfathered in because they were introduced before we enforced linting).
If we want lint-amnesty to continue to mean something, then we need to add a check that will hard-code a maximum number of lint-amnesty comments and fail CI if any more area added.
Alternatively, we call it a wash and blanket replace every occurance of lint-amnesty, pylint: with pylint:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the CI lint configuration and searching the repository for lint-amnesty, pylint: comments. Clarify whether the intended outcome is a CI-enforced maximum or a blanket replacement, then verify that the selected policy detects or removes newly added comments without breaking linting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100