Review
Every item is checked before it appears in the library. Reviewers are student volunteers.
Who reviews
- For now: the repository maintainer (@xeroz369), listed in
.github/CODEOWNERS. - As more people join, each faculty or group of courses gets its own reviewers, also listed in
CODEOWNERSby course folder. GitHub then requests the right reviewer on each pull request. - To review for a course you know well, open the Become a reviewer form.
The steps a contribution goes through
- Sent: through the upload page (a bot opens a pull request), through the Add a link form (an issue with the
cần duyệtlabel; the reviewer opens the pull request from the issue by hand), or as your own pull request. - Automatic checks: for files sent through the web page, the
kiem-fileworkflow 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. ThevalidateCI checks format, file types, sizes and duplicates. - A reviewer reads it using the checklist below and asks the sender questions in the pull request or issue when needed.
- 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-fileworkflow publishes the file to thefiles-HKxxxGitHub pre-release. If the pull request is closed instead,don-khocleans up the waiting file. - 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
- Pull requests with a Môn mới (new course) line: check the course code, name and faculty against the HCMUT handbook (link in the pull request). If it duplicates an existing course, close the pull request and ask the sender to pick that course.
- It is not a copyrighted book file. Books become the Sách tham khảo type, listed by title only.
- Personal information: read the machine warning in the PR and decide. It only warns, it does not block.
- License: CC BY-SA 4.0 (or CC BY 4.0, CC0) for the sender's own work; for links, the source's actual license.
- Right course, right type, a clear title, no advertising.
- For .zip files (quiz packs only): open them and check that there are no executables.
- Pull requests labelled
can-xem-tay: the checks could not decide. Read the reason in the comment, then open the file on a machine with antivirus software. - The text a sender typed is public in the item file of the pull request as soon as it is sent: close pull requests with abusive text, ads or odd links right away.
Details (in Vietnamese): CONTRIBUTING.md.