UCL-ARC / UCL-ARC/python-tooling

Applying the cookiecutter on an existing repo

Đang mở
#416 8 bình luận 5 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

documentation enhancement question
Ngôn ngữ chính
Python
Star
62
Fork
10
Merge trung bình
7 ngày 6 giờ
Pull request đã merge (30 ngày)
6

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.