purescript / purescript/trypurescript

Create a dedicated development & release guide

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

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

Ngôn ngữ chính
PureScript
Star
121
Fork
51
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

As discussed in #218, I think we ought to split out the development instructions for Try PureScript from the main README, and we should expand those instructions to include cutting new releases of the project.

The development instructions should cover what they already do: how to set up the local server, how to set up the local client, and how to update the packages and package set.

The release instructions could include things not currently described, including:

  • Updating the hardcoded tag used for examples
  • How to check that the externs for an upgraded package set don't overwhelm the server
  • How to run a deployment

and ideally this could be aggregated in checklist form, so someone who wants to make a release can move step-by-step through the instructions from a fresh clone of the repository.

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

Start with the main README and the discussion in #218, then trace the existing instructions for setting up the local server and client and updating packages and the package set. Done means a dedicated guide with a fresh-clone checklist covering those development steps plus tag updates, externs checks, and deployment.

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

Đánh giá

Lĩnh vực
documentation, release
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 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
42/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.