Overview of copier questions

[fdiblen]

Template Profiles

This is a list of questions and features being asked by copier. It is a slightly modified version of profiles.md file. We will update this list after adding new features.

Files

minimum profile

  src/
  docs/
  test/
  pyproject.toml
  README.md
  .gitignore
  MANIFEST.in
  LICENCE

Questions

Essentials (for all profiles)

• template_profile
  • minimum --> DONE
  • recommended --> all questions - excluded with the defaults
  • optional --> all questions with answers off
• package_name
• version
• licence

Package details (for recommended and ask profile)

• package_short_description
• github_organization
• full_name
• email
• copyright_holder

Features (for recommended and ask profile)

Note: :white_check_mark: indicates whether the feature is implemented.

---

• community

  • :white_check_mark: code of conduct #530 --> if TRUE ask for email
  • :white_check_mark: contributing guidelines #543

• documentation

  • :white_check_mark: developer documentation #541
  • :white_check_mark: online documentation (read the docs)
  • project_setup.md #553
  • markdown link checker workflow

• code quality:

  • :white_check_mark: sonarcloud #515
  • ruff and lint workflow
  • :white_check_mark: github action to build (exist) #451
  • :white_check_mark: pre-commit #487
  • .editorconfig

• publishing and release

  • :white_check_mark: zenodo #520
  • :white_check_mark: keywords (implemented as a question)
  • :white_check_mark: changelog.md #480
  • :white_check_mark: cffconvert workflow and citation file #471

• Other

Questions to exclude from recommended profile

• markdown link checker
• pre-commit
• changelog.md
• project_setup.md