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

Draft OEP-34: Lint Amnesty #108

Merged
merged 7 commits into from
May 3, 2021
Merged

Draft OEP-34: Lint Amnesty #108

merged 7 commits into from
May 3, 2021

Conversation

cpennington
Copy link
Contributor

No description provided.

--------

In all repositories, we will grant amnesty to all existing linting violations.
This includes pylint, xsslint, pycodestyle, and any other linting programs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally love the idea, but I have some hesitation around xsslint, especially when it comes to repos that haven't yet employed it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess my feeling is that adding the ignores is no worse (and probably better) than having cap on the number. Either way, the issues aren't being immediately fixed, and I think flagging them in the code makes them more visible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The xsslint issues are being fixed. I'd still recommend not listing this, but I'll leave that to the security team to determine.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@feanil: It looks like this got merged, but I still propose that xsslint gets dropped from this list.

The amnesty tool has been in heavy use so I think it's safe to say
it's not just a prototype anymore.
@regisb
Copy link

regisb commented Apr 3, 2021

This is a great step forward for the Open edX codebase. Among other benefits it will make life much easier for first time-contributors.
On a related note, as a big fan of static checking, I recently setup type checks with mypy across the entire tutor code base: overhangio/tutor@0a670d7
If anyone is interested I can provide some feedback (spoiler:the experience was very positive).

Accepted the oep after a complete review process and discussions.
@UsamaSadiq UsamaSadiq merged commit 5e39ecf into master May 3, 2021
@UsamaSadiq UsamaSadiq deleted the lint-amnesty branch May 3, 2021 20:29
davidjoy pushed a commit that referenced this pull request Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants