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

[OpenSSF] Addressing Warnings #515

Open
Zeitsperre opened this issue Jan 21, 2025 · 0 comments
Open

[OpenSSF] Addressing Warnings #515

Zeitsperre opened this issue Jan 21, 2025 · 0 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Zeitsperre
Copy link
Contributor

Generic Issue

  • xscen version: v0.10.2-dev
  • Python version: Any
  • Operating System: All

Description

Barring a few small issues, our progress with the OpenSSF Best Practices are looking pretty good (https://www.bestpractices.dev/en/projects/9945).

The only significant issue that is blocking 100% ("passing" status) is the amount of warnings emitted from the testing steps. From the scoring rubric:

  • The project MUST address warnings: These are the warnings identified by the implementation of the warnings criterion. The project should fix warnings or mark them in the source code as false positives. Ideally there would be no warnings, but a project MAY accept some warnings (typically less than 1 warning per 100 lines or less than 10 warnings).
  • It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical: Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

Many of the warnings we see are different between version of Python (due to deprecations of functions between older and newer versions of libraries). Ideally, tackling these would involve addressing warnings emitted in older Python builds first (Python3.10) and then moving onto to newer ones (this is how we tackled things in xclim).

Eliminating warnings is not possible (nor is it the goal), but we're seeing nearly 1700 warnings emitted in the typical testing suite, which is a bit much.

@Zeitsperre Zeitsperre added good first issue Good for newcomers help wanted Extra attention is needed labels Jan 21, 2025
@Zeitsperre Zeitsperre self-assigned this Jan 21, 2025
@Zeitsperre Zeitsperre mentioned this issue Jan 22, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant