-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
effort: highEstimated high effort taskEstimated high effort taskimpact: highEstimated high impact taskEstimated high impact task
Description
After having looked at various NiPreps repositories and having given this a first try in https://github.com/jhlegarreta/niprep-cookiecutter/tree/enh/add-cookiecutter-files, I think we should answer a few questions to agree on the cookiecutter structure and to open a PR using that branch:
Structure:
- Do we need a
setup.cfgfile? - Should tests be all in an external/common folder or inside each module?
- Should the testing module be named
testortestsif in an external/common folder? - Should
project_slugcontents be inside ansrcfolder? - Do we need a
configmodule with an__init__.pyfile?
Maintenance files:
update_changes.shis different acrossnifreezeandfmriprep. Which one should we use to host the bare but functional minimum?- Should there be an
update_description.pyfile like innifreeze? - Should there be a
.mailmap? - Should there be a
.gitattributesfile?
CI related:
- Should there be a first interaction message?
- Should there be an
ISSUE_TEMPLATEfile? - Should there be a
dependabot.yml? - Should there be a
stale.yml? - Should there be a
contrib.yml? - Should there be a
docs-build.yml? - Should we add CircleCI testing ? If so, we'll need to add env variables to
pass_envintox.ini
Documentation
- Should
READMEbe a markdown or an rst file? Depending on the answer we may need to add areadmeproperty to project inpyproject.toml?
Contents:
- Should we create
docs/conf.pyandconftest.pyfrom scratch to avoid carrying over unnecessary content that we may carry over otherNiPrepsrepositories? Same fortox.iniandpyproject.toml.
Metadata
Metadata
Assignees
Labels
effort: highEstimated high effort taskEstimated high effort taskimpact: highEstimated high impact taskEstimated high impact task