BK Study LibraryStudy material shared by HCMUT students

Review

Every item is checked before it appears in the library. Reviewers are student volunteers.

Who reviews

The steps a contribution goes through

  1. Sent: through the upload page (a bot opens a pull request), through the Add a link form (an issue with the cần duyệt label; the reviewer opens the pull request from the issue by hand), or as your own pull request.
  2. Automatic checks: for files sent through the web page, the kiem-file workflow scans for viruses, strips metadata (PDF, images, Office files), warns about student IDs, emails, phone numbers, JavaScript in PDFs and macros in Office files, and writes the release link into the pull request. The validate CI checks format, file types, sizes and duplicates.
  3. A reviewer reads it using the checklist below and asks the sender questions in the pull request or issue when needed.
  4. Merged: clean submissions are merged automatically once checks pass; safe but uncertain ones are merged too and listed on Unclassified material; past exams, book-length files and files with serious warnings wait for a reviewer to merge. The phat-hanh-file workflow publishes the file to the files-HKxxx GitHub pre-release. If the pull request is closed instead, don-kho cleans up the waiting file.
  5. The issue is closed (for links) with a link to the course page.

Target: a reply to every contribution within seven days. Takedown requests are handled first; see Takedown.

Reviewer checklist

Details (in Vietnamese): CONTRIBUTING.md.