Skip to content

Questions for the cookiecutter structure #6

@jhlegarreta

Description

@jhlegarreta

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.cfg file?
  • Should tests be all in an external/common folder or inside each module?
  • Should the testing module be named test or tests if in an external/common folder?
  • Should project_slug contents be inside an src folder?
  • Do we need a config module with an __init__.py file?

Maintenance files:

  • update_changes.sh is different across nifreeze and fmriprep. Which one should we use to host the bare but functional minimum?
  • Should there be an update_description.py file like in nifreeze?
  • Should there be a .mailmap?
  • Should there be a .gitattributes file?

CI related:

  • Should there be a first interaction message?
  • Should there be an ISSUE_TEMPLATE file?
  • 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_env in tox.ini

Documentation

  • Should README be a markdown or an rst file? Depending on the answer we may need to add a readme property to project in pyproject.toml?

Contents:

  • Should we create docs/conf.py and conftest.py from scratch to avoid carrying over unnecessary content that we may carry over other NiPreps repositories? Same for tox.ini and pyproject.toml.

Metadata

Metadata

Assignees

No one assigned

    Labels

    effort: highEstimated high effort taskimpact: highEstimated high impact task

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions