search

napari / cookiecutter-napari-plugin

Cookiecutter for napari plugins
BSD 3-Clause "New" or "Revised" License
69 stars 41 forks source link

Add prompts reference with description for each prompt #47

Closed DragaDoncila closed 3 years ago

DragaDoncila commented 3 years ago

Based on discussion in #46 this PR adds some documentation explaining what each prompt means and how it is used in the resulting package template.

I've also added a line linking to this document from the README. I'm not sure if that'll be easily missed, but I also didn't want to overcrowd the README.

I'd appreciate a read through and any feedback on important information I may have missed - in particular for the semi-controversial use_git_tags_for_versioning option.

DragaDoncila commented 3 years ago

@tlambert03 I've updated the wording for the use_git_tags_for_versioning prompt, but I wholeheartedly agree with you that we should change the default for that prompt to "y" so that I can change the wording to more strongly recommend the default and move the explanation for choosing "n" down to where it's less likely to confuse new users

sofroniewn commented 3 years ago

Thanks for updates here @DragaDoncila

@tlambert03 I've updated the wording for the use_git_tags_for_versioning prompt, but I wholeheartedly agree with you that we should change the default for that prompt to "y" so that I can change the wording to more strongly recommend the default and move the explanation for choosing "n" down to where it's less likely to confuse new users

I agree with default being y and rewording. We could though merge this PR now as is just to get docs in and then update this when/ if we change default. i'm fine either way

DragaDoncila commented 3 years ago

@tlambert03 thank you for adding more detail and clarification for the setuptools-scm versioning choice. I've committed that and I think this is now ready to merge, and we'll make the necessary changes after #48 is merged and we change the default to use git tags.