Skip to content

Improve documentation on applying template to an existing codebase #589

Open
@sjvrijn

Description

@sjvrijn

When applying the template to an existing codebase, two things come up that may confuse people:

  1. If certain files already exist (pyproject.toml, CITATION.cff, etc.), they are deliberately skipped. A note saying that this is indeed deliberate may be helpful
  2. For any other existing files, copier will ask if it should overwrite the file. Most people's first instinct seems to be to answer no, because they don't want to lose data, but are interested in the improvements. If the existing codebase is already a git repo however, the recommended answer should be yes, and then let git deal with displaying the difference.

Metadata

Metadata

Assignees

No one assigned

    Labels

    templateRelated to the template itself, as opposed to the generated code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions