Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

DOCS: Create standard for format and structure of top-level project files across AboutCode repos

Đang mở
  • Có gì không ổn?
#66 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.

Đánh giá

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

Hướng nghiên cứu

Bắt đầu bằng cách so sánh các tệp cấp cao nhất được liệt kê trong dejacode, purldb, scancode.io, scancode-toolkit và vulnerablecode. Issue nêu các mục tiêu trước mắt: chuyển RELEASE.md trong dejacode và scancode.io sang rST, đổi tên các tệp apache-2.0.LICENSE thành LICENSE và ghi lại tiêu chuẩn cho các repository AboutCode mới. Được xem là hoàn tất khi quy ước về tên/định dạng tệp được áp dụng hoặc được ghi lại rõ ràng, nhưng issue này đã cũ và trải rộng trên nhiều repository.

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

Mô tả

documentation

In most AboutCode repos we have a set of top-level project files including:

  • AUTHORS.rst
  • CHANGELOG.rst
  • CODE_OF_CONDUCT.rst
  • CONTRIBUTING.rst
  • LICENSE
  • NOTICE
  • README.rst
  • RELEASE.md (dejacode and scancode.io)
  • ROADMAP.rst

I looked at dejacode, purldb, scancode.io. scancode-toolkit and vulnerablecode as the primary examples

Although the GitHub norm is for the these files to be in markdown format we are using rST in most cases so the cost/effort to move to markdown does not make sense at this time.

For the LICENSE and NOTICE files we have a mixed bag:

  • dejacode: LICENSE file but no NOTICE (makes sense for AGPL-3.0 vs Apache-2.0)
  • purldb: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
  • scancode.io: LICENSE and NOTICE files - this should be the pattern for all projects licensed under Apache-2.0)
  • scancode-tookit: NOTICE file plus apache-2.0.LICENSE and cc-by-4.0.LICENSE
  • vulnerablecode: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE

If you have a top-level file named LICENSE GitHub displays the license name in a "tab" at the top of the README. Using LICENSE as the file suffix does not seem to mean anything to GitHub.

The issue here is to standardize the format and structure of these files across repos and document it for new projects/repos. Some immediate action items include:

  • Convert RELEASE.md files to rST for dejacode and scancode.io (this should be easy since these are small chunks of text)
  • Rename apache-2.0.LICENSE files to LICENSE.
Ngôn ngữ chính
JavaScript
Star
9
Fork
17
Merge trung bình
7 giờ 55 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của aboutcode-org/www.aboutcode.org

Tất cả issue của aboutcode-org/www.aboutcode.org

Issue tương tự

Thêm issue về JavaScript

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.