search

JuliaBesties / BestieTemplate.jl

Template for Julia Programming Language packages using the copier engine.
http://JuliaBesties.github.io/BestieTemplate.jl/
Mozilla Public License 2.0
52 stars 11 forks source link

Generate checklist for package author #499

Open lucaferranti opened 1 month ago

lucaferranti commented 1 month ago

Description

When creating a new package, there are a couple of things that need to be setup for the package to work but that tend to be forgotten, hence being common FAQ. Off the top of my head, probably a few more

It would be cool to provide the user with a todo-list of things that need to be manually setup. I am not sure what could be the best way to implement this, maybe generate a _MISSING_SETUP_STEPS.md file with these tips and after BestieTemplate.generate has successfully run, print at the end a message "Check TODO.md to see what you need to setup manually" or something like that.

Validation and testing

I am not familiar enough with BestieTemplate.jl testing framework to give a detailed answer. Tests should check the file is properly generated in the same way it's doing it already.

Motivation

When creating new packages, especially for new developers, there are some "common beginner mistakes" that tend to be done often, this feature would offer them a smoother experience

Target audience

Useful for new people starting developing julia libraries

Can you help?

yes

abelsiqueira commented 1 month ago

This matches the intent of #157. My current idea is based on what the https://github.com/NLeSC/python-template does (or did, they are refactoring to use copier so things are changing), which is to automatically create issues with the TODO list. Notice that this info is/should be in the full guide, which is why #157 is titled like "add links to full guide to generated package", but I agree that it's not enough to have it there.