biocommons.seqrepo icon indicating copy to clipboard operation
biocommons.seqrepo copied to clipboard

Make coding style consistent with hgvs / enforce black and pylint

Open holtgrewe opened this issue 1 year ago • 3 comments

There is much more to coding style than indentation and static error analysis with lint. However, these can be enforced automatically.

Looking at the CI files for hgvs, the following appear to be useful:

  • black (version should be pinned on installation as format changes slightly over time and black updates should be explicit as not to get whitespace change noise in commits)
  • flake8 with reasonable configuration
  • isort (probably with profile black)

holtgrewe avatar May 04 '23 06:05 holtgrewe

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

github-actions[bot] avatar Sep 18 '23 01:09 github-actions[bot]

This issue was closed because it has been stalled for 7 days with no activity.

github-actions[bot] avatar Sep 25 '23 01:09 github-actions[bot]

I don't necessarily want to close this yet, but we're currently trying to be more purposeful about basing things like styling off of what's defined in the template first. That's entailed a slow (still ongoing) rollout of changes across biocommons - we've made some decisions about configs but are taking our time to populate them out to the repos because we don't want to impact ongoing PR discussions. This repo is pretty clean, though, so we could probably get them done soon.

Broadly, unless there's a repo-specific configuration to implement, I think we generally want to form a consensus around linting/formatting/etc on the example repo first, and go from there.

jsstevenson avatar Jul 25 '24 00:07 jsstevenson