python / python/python-insider-blog
README instructions for writing blog entries do not work as-is
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Astro
- Star
- 32
- Fork
- 12
- Merge trung bình
- 9 giờ 37 phút
- Pull request đã merge (30 ngày)
- 9
Mô tả
The README currently says:
You can pull the repo, run
make dev, and edit the page via Keystatic with the nice UI
I did so, and noticed that this had an implicit dependency on Bun. This dependency should be called out.
After installing Bun, I got a different failure due to the astro not being installed:
❯ make dev
bun run dev
$ astro dev
/bin/bash: astro: command not found
error: script "dev" exited with code 127
make: *** [dev] Error 127
This is because, the user needs to do a make install before make dev.
I did end up writing it in Markdown, since I'm familiar with that.
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Cập nhật hướng dẫn trong README về cách viết các bài blog. Xác minh thiết lập được ghi trong tài liệu bằng cách kiểm tra workflow make dev và make install, sau đó nêu rõ rằng Bun là bắt buộc và make install phải được chạy trước make dev; công việc được xem là hoàn thành khi một contributor mới có thể làm theo hướng dẫn mà không gặp các lỗi đã được báo cáo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- bun
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 78/100