scipp / scipp/copier_template

Template dev docs: Add page/section documenting that the rendered repo was made using this repo

Open
#257 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jinja
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

I don't think we have info linking back to this repo, how to run copier update, etc.?

Is a section in the dev docs enough, or should there also be a note in the README?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the dev docs and README mentioned in the issue, then review how the rendered repository currently relates to this template. Document that relationship and how to run copier update, resolving whether the guidance belongs only in dev docs or also in the README. Done when users can find and follow the update instructions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.