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

Enhancement : Add templating for issue labels, contributing.md, workflows, linters #12

Closed
twilwa opened this issue Oct 5, 2024 · 1 comment

Comments

@twilwa
Copy link

twilwa commented Oct 5, 2024

Saw the TODO's and thought I'd start with housekeeping -- wanted to make an issue to check in and see if we have preferred conventions for testing, issue/PR templates, formatting + linting options, necesary workflows, etc before I pushed something that was noisy or enforced conventions we don't want to use.

I found a few template options, gpt summary as follows:

Serious Scaffold Python

Linting, testing, CI/CD workflows, release automation, documentation.
Utilizes tools like pdm, pre-commit, mypy, ruff, pytest, sphinx, typer, semantic-release, and Renovate.

Copier Poetry

Pre-configured tools for code formatting, quality analysis, testing, documentation.
Uses MkDocs, GitHub workflow and GitLab CI support, and auto-generated changelogs and credits. Poetry specific.

Netherlands eScience Center Python Template

A Copier template with best practices for research software.
Offers various user profiles (Minimum, Recommended, Let me choose) to cater to different needs.
Includes boilerplate tests, documentation, CI/CD workflows, code style checking, contribution guidelines, and more.
Supports FAIR software practices and provides a range of badges for various metrics.

Copilot wasn't particularly helpful with descriptions, but if you've got the broad-strokes or an 'idc lets see what u got' then I'll just pick the closest one and start a draft PR to work out of once I get the foundations done.

@twilwa
Copy link
Author

twilwa commented Oct 7, 2024

I beleive #30 closes this effectively, but happy to continue discussion for workflows or other housekeeping there.

@twilwa twilwa closed this as completed Oct 7, 2024
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

1 participant