angelolab / angelolab/maldi-tools

Restructure the repo

Ouverte
#18 0 commentaires 0 réactions 1 personne assignée Réclamée par @srivarra Voir sur GitHub
enhancement
Langage dominant
Python
Étoiles
1
Forks
0
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

The current repo structure is half baked at best.

As we add features, a set organization will be prove to be useful over the long term.

The [scverse cookiecutter](https://github.com/scverse/cookiecutter-scverse) comes with a lot of nice functionality built in. Check out the default example repo it [generates](https://github.com/scverse/cookiecutter-scverse-instance):
- automated testing with [pytest](https://docs.pytest.org/)
- continuous integration using GitHub actions.
- documentation hosted by [readthedocs](https://readthedocs.org/)
- coverage tests with [codecov](https://about.codecov.io/)
- [pre-commit](https://pre-commit.com/) checks for code style and consistency
- tutorials with [myst-nb](https://myst-nb.readthedocs.io/) and jupyter notebooks
- [bump2version](https://github.com/c4urself/bump2version/) for managing releases

This will help to ensure better code quality. In addition we should add developer documentation with recommended learning material.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.