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

Replace placeholder text in `README.md` — license, maintainers, and duplicated heading

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#175 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu từ README.md: tiêu đề bị lặp ## Operational notes nằm khoảng dòng 254-256, chỗ giữ chỗ của giấy phép khoảng dòng 279, chỗ giữ chỗ của người duy trì khoảng dòng 281-283 và URL clone khoảng dòng 99. Hãy sao chép nội dung Apache-2.0 từ tệp LICENSE ở thư mục gốc thay vì gõ lại, và để tên người duy trì ở dạng TODO trừ khi người duy trì cung cấp. Sửa lỗi mojibake trong CONTRIBUTING.md (dòng 3) và ROADMAP.md, sau đó tìm ký tự thay thế trong cả ba tệp. Hoàn thành khi danh sách kiểm tra chấp nhận trong issue đạt yêu cầu và các tệp được lưu dưới dạng UTF-8.

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

Mô tả

documentation good first issue

Problem

README.md contains leftover template scaffolding:

  1. Duplicated heading (lines 254-256):

    ## Operational notes

## Operational notes

    The heading appears twice back to back.

  2. Empty license section (line 279):

    ## License

Specify the project license here.

    A LICENSE file exists at the repo root and package.json declares "license": "Apache-2.0", so the correct text is known — it just was not filled in.

  3. Empty maintainers section (lines 281-283):

    ## Maintainers

- (Add maintainers here)

  4. Stale install URL (line 99): git clone https://github.com/alian-structure/alian-structure-api.git — but the repository lives at github.com/SourceXXL/alian_structure-api. A clone following the README will 404 for anyone without the org.

Also worth noting: CONTRIBUTING.md line 3 and ROADMAP.md both contain mojibake — a corrupted multi-byte character renders as �?. These are almost certainly UTF-8 read as another encoding and should be repaired.

Why it matters

The README is the first thing every contributor and every evaluator reads. A file that says "Specify the project license here" undermines the claim that the project is Apache-2.0 licensed, and a clone URL that 404s is a genuine first-run blocker. The mojibake suggests at least one commit wrote non-UTF-8 content, which can recur.

Suggested Direction

Straightforward edits to README.md:

  1. Delete the duplicate ## Operational notes heading at line 256.
  2. Replace line 279 with the standard Apache-2.0 notice, matching the LICENSE file at the repo root.
  3. Fill in the maintainers section with real names/handles — ask a maintainer rather than guessing.
  4. Fix the clone URL to the actual repository location.
  5. Repair the mojibake in README.md, CONTRIBUTING.md and ROADMAP.md, saving as UTF-8.

Consider adding an editorconfig (.editorconfig with charset = utf-8) to stop this recurring.

Constraints

  • Do not invent maintainer names or contact addresses — leave a placeholder comment if a maintainer has not supplied them.
  • Do not restate the Apache-2.0 text from memory; copy it from the existing LICENSE file so they cannot diverge.

Acceptance Criteria

  • ## Operational notes appears exactly once.
  • The License section matches the LICENSE file.
  • The maintainers section is filled in, or explicitly marked as TODO by a maintainer.
  • The clone URL resolves to a real repository.
  • No mojibake remains in README.md, CONTRIBUTING.md or ROADMAP.md.
  • All files saved as UTF-8; optionally add .editorconfig with charset = utf-8.
Ngôn ngữ chính
TypeScript
Star
7
Fork
55
Merge trung bình
1 ngày 17 giờ
Pull request đã merge (30 ngày)
5

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

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 SourceXXL/alian_structure-api

Tất cả issue của SourceXXL/alian_structure-api

Issue tương tự

Thêm issue về TypeScript

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.