borg icon indicating copy to clipboard operation
borg copied to clipboard

Core Infrastructure Initiative (CII) Best Practices

Open ypid opened this issue 9 years ago • 7 comments

Status: CII Best Practices

I would like to point you to the CII Best Practices Badge Program. Could you go thought the criteria and keep them up-to-date there? I think you have a pretty good chance of meeting most criteria already :wink:

Refs:

  • https://bestpractices.coreinfrastructure.org
  • https://twit.tv/shows/floss-weekly/episodes/389

ypid avatar Aug 07 '16 08:08 ypid

doing that, thanks for the pointer. :)

ThomasWaldmann avatar Aug 07 '16 12:08 ThomasWaldmann

stuff that (sometimes is somehow there but) could be better:

  • check usage of warning flags / linters (aside from pep8)
  • regularly use dynamic and static analysis tools

https://bestpractices.coreinfrastructure.org/projects/271

ThomasWaldmann avatar Aug 07 '16 13:08 ThomasWaldmann

@ThomasWaldmann: For the dyanimc/static analysis tools, do you think pylint would qualify? If you would find it useful, I can work on adding it to the travis job.

DArtagan avatar Mar 28 '17 06:03 DArtagan

my personal experience with pylint is that the time it takes to make it stop writing out false positives is a problem

RonnyPfannschmidt avatar Mar 28 '17 07:03 RonnyPfannschmidt

That's true, Pylint is extremely stylistically strict by default and it produces a lot of nit picky output. One can drown in the deluge. I see you have a lot of experience with pytest, pylint stumbles a lot when it comes upon pytest hooks and other creative patterns. It takes some time to tune those out.

In the past, when I've begun using it on existing projects, I start by running it with --errors-only (which disables style checking) until I've dealt the actual code errors and initial setup. The configuration can be later tweaked from there to increase code quality.

A lot of words to say: I'm willing to put in the time.

DArtagan avatar Mar 28 '17 13:03 DArtagan

update this about #2423.

ThomasWaldmann avatar Feb 16 '19 11:02 ThomasWaldmann

added bandit, see #8894.

ThomasWaldmann avatar Jun 01 '25 12:06 ThomasWaldmann

added ASan / UBSan in #9139.

now at 100%, yay.

ThomasWaldmann avatar Nov 03 '25 20:11 ThomasWaldmann