UCL-ARC / UCL-ARC/python-tooling

Applying the cookiecutter on an existing repo

オープン
#416 コメント 8 件 リアクション 5 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

documentation enhancement question
主要言語
Python
スター
62
フォーク
10
平均マージ
7日 6時間
マージ済み PR(30日)
6

説明

Is Your Feature Request Related to a Problem? Please Describe

When @samcunliffe and I had to apply a cookiecutter to an existing repo, we ended up creating the template on a separate directory and copying files across. Is there a better way to do this? And should we document this usecase in this repo?

@matt-graham mentioned that in the ARC festival workshop they tried a different approach to keep the git history.

Describe the Solution You'd Like

Mention this case in the readme and add some steps with the best way to do this.

Describe Alternatives You've Considered

No response

Additional Context

No response

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Review the README and the existing issue discussion, then compare the approach used in the ARC festival workshop for applying a cookiecutter while preserving Git history. Document the recommended workflow for applying the template to an existing repository, including steps for the reported use case; done when a newcomer can follow the README without copying files manually.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。