angelolab / angelolab/maldi-tools

Restructure the repo

未关闭
#18 0 条评论 0 个 reaction 已指派 1 人 已被 @srivarra 认领 在 GitHub 查看
enhancement
主要语言
Python
星标
1
派生
0
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。