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

Make coding style consistent with hgvs / enforce black and pylint #108

Open
holtgrewe opened this issue May 4, 2023 · 3 comments
Open
Milestone

Comments

@holtgrewe
Copy link
Contributor

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 added a commit to holtgrewe/biocommons.seqrepo that referenced this issue May 4, 2023
Also includes this as a check in CI.
@github-actions
Copy link

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 github-actions bot added the stale Issue is stale and subject to automatic closing label Sep 18, 2023
@github-actions
Copy link

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

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 25, 2023
@reece reece added stale closed Issue was closed automatically due to inactivity and removed stale closed Issue was closed automatically due to inactivity labels Nov 27, 2023
@reece reece added this to the 0.7 milestone Nov 27, 2023
@reece reece reopened this Nov 27, 2023
@reece reece removed the stale Issue is stale and subject to automatic closing label Nov 27, 2023
@jsstevenson
Copy link
Contributor

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.

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

No branches or pull requests

3 participants