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

Lab software standards, software project templates #8

Closed
jsstevenson opened this issue Oct 21, 2022 · 2 comments
Closed

Lab software standards, software project templates #8

jsstevenson opened this issue Oct 21, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request free day Issues that promote a general sense of well-being

Comments

@jsstevenson
Copy link
Member

jsstevenson commented Oct 21, 2022

This is highly aspirational, but I'd be interested in defining some common code and project standards where possible. All of this would be domain and/or language specific, but I'm thinking of stuff like (taking Python as an example)

  • Linting/formatting (Black? Flake8? And any custom settings therein. Plus Isort, Darglint)
  • Testing (We're more or less settled on Pytest, but what kind of coverage tools and settings? Use Tox for encapsulated testing? Run mypy checks as well?)
  • Common pre-commit hooks for as much of the above as possible
  • Build tool -- pyproject.toml?
  • Environment management - stick with Pipenv or move to Poetry?
  • CI driven checks on conventional commit messages? Auto generate release notes and versioning?

In particular, if we could identify consistent elements from the above that could structure a Cookie Cutter template, that might be useful for ensuring that new projects start on the right foot, and with minimal labor to tack on necessary boilerplate.

@jsstevenson jsstevenson added the free day Issues that promote a general sense of well-being label Oct 21, 2022
@jsstevenson jsstevenson changed the title Software standards, software project templates Lab software standards, software project templates Oct 21, 2022
@jsstevenson jsstevenson self-assigned this Dec 21, 2022
@korikuzma korikuzma added the enhancement New feature or request label Dec 30, 2022
@jsstevenson
Copy link
Member Author

@korikuzma
Copy link
Member

@jsstevenson You did it! https://github.com/GenomicMedLab/software-templates 🚀 . I'm going to close this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request free day Issues that promote a general sense of well-being
Projects
None yet
Development

No branches or pull requests

2 participants