-
Notifications
You must be signed in to change notification settings - Fork 10
Description
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
- Setting up needed keys for documentation deployment with
DocumenterTools
- (TIL) setting up
CODECOV_TOKEN
for coverage
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