lincc-frameworks / lincc-frameworks/python-project-template

Option to overwrite project README when hydrating

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

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

enhancement
Ngôn ngữ chính
Jinja
Star
85
Fork
16
Merge trung bình
6 giờ 18 phút
Pull request đã merge (30 ngày)
1

Mô tả

"Oh no! It does this thing where it doesn't overwrite the readme, and we do a lot of badges and things in there. We should change that," @delucchi-cmu says, while hydrating desi-aap for the incubator.

I agree--if you're hydrating a fresh github repo, there's a good chance you clicked the option to create a blank README, so it'd be really nice to have it replaced with something more useful.

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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

Bắt đầu từ đường dẫn hydration của template và kiểm tra cách một GitHub README trống hiện có được phát hiện hoặc giữ nguyên. Hoàn thành khi hydration có thể thay thế README đó bằng README hữu ích hơn của project, đồng thời cả hành vi mặc định và tùy chọn ghi đè đều được bao phủ bởi các test.

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
developer-experience, tooling
Loại issue
Tính năng
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
58/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.