UCL-ARC / UCL-ARC/python-tooling

Add contributors guidelines to template

Đang mở
#614 3 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
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

Currently the package template does not include a CONTRIBUTING.md guidelines page, but this is quite a well suited page for templating given a basic guide can use largely pro-forma text with a few templated links. While it will need to be relatively generic, I think having something basic included by default in template would be good.

Describe the Solution You'd Like

A CONTRIBUTING.md contributors guide in the cookicutter template. We added a basic guide to S2FFT recently which could be used as starting point (as could probably many others this one is just recent in memory!).

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

Start by locating the cookiecutter package template and reviewing the linked S2FFT CONTRIBUTING.md guide as a possible model. Add a generic CONTRIBUTING.md with templated links, then verify that newly generated Python packages include the guide and that its links are appropriate for the template.

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, tooling
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
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
55/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.