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

Restructure the repo #18

Open
Tracked by #15
srivarra opened this issue Oct 25, 2023 · 0 comments
Open
Tracked by #15

Restructure the repo #18

srivarra opened this issue Oct 25, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@srivarra
Copy link
Collaborator

srivarra commented Oct 25, 2023

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 comes with a lot of nice functionality built in. Check out the default example repo it generates:

  • automated testing with pytest
  • continuous integration using GitHub actions.
  • documentation hosted by readthedocs
  • coverage tests with codecov
  • pre-commit checks for code style and consistency
  • tutorials with myst-nb and jupyter notebooks
  • bump2version for managing releases

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

@srivarra srivarra changed the title Restructure, use cookiecutter-scverse Restructure the repo Oct 25, 2023
@srivarra srivarra added the enhancement New feature or request label Oct 25, 2023
@srivarra srivarra self-assigned this Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant