Người dùng khi thực hiện thay đổi và muốn đóng góp vào branch chính master cần tuân thủ một số quy tắc để đóng góp có thể được thông qua.

• Chỉ đóng góp về mặt nội dung, tức là bổ sung các tệp PDF, web clone, và thực hiện các thay đổi phù hợp với đóng góp
• Không push lên các nội dung nhạy cảm không liên quan đến dự án
• Không thực hiện thay đổi lên codebase, tức là các file script PHP, style CSS, JavaScript, HTML.

1. Cấu trúc dữ liệu
2. Đóng góp nội dung

Người đóng góp nội dung cho trang web chỉ cần quan tâm đến thư mục physics

- physx-cnh
	- blog
	- daily
	- image
	- js
	- nav
	- physics  
	- visit_count
	- whats-new
	- .htaccess
	- 404.php 
	- disclaimer.html  
	- LICENSE
	- README.md
	- welcome.php  

Thư mục physics chứa toàn bộ nội dung quan trọng của trang web mà người dùng có thể đóng góp bổ sung, ngoài ra, các mục khác là

• daily : chuyên mục bài tập hàng ngày, sẽ đi vào vận hành
• image : chứa tài nguyên ảnh của trang web
• js : chứa script của trang chủ
• nav : chứa php của trang điều hướng tài liệu
• visit_count : chứa script và dữ liệu số lượt truy cập
• whats_new : thông báo cập nhất ở trang chủ
• .htaccess : config trang web
• 404.php : trang báo lỗi 404 Page Not Found
• disclaimer.html: trang Miễn trừ trách nhiệm pháp lý
• LICENSE - license GPL-3.0
• README.md
• welcome.php : Trang chủ

Khi tiến vào thư mục physics, cấu trúc dữ liệu như sau:

- physics  
	- books
		- PFIEV
			- //sách PFIEV - PDF//
		- //Sách PDF//
	- img
	- lessons
	- materials
		- apho.olimpicos.net
		- eupho.olimpicos.net
		- handouts
			- //tài liệu handouts - PDF//
		- ipho.olimpicos.net
		- nbpho.olimpicos.net 
		- quantum
			- //tạp chí quantum - PDF//
		- rmph.olimpicos.net
		- vltt
			- //tạp chí VL&&TT - PDF//
		- //Các đề thi và đáp án - PDF//
	- viewer
	- books-pre-vpho.txt
	- books-vpho-en.txt
	- books-vpho-en.txt 
	- lessons.txt
	- magazines.txt
	- material-pho.txt 
	- paper-sol-pho.txt

Tài nguyên web-based là tài nguyên Web Copy của một trang web nhất định, ví dụ như các tài nguyên apho.olimpicos.net, eupho.olimpicos.net, v.v... các tài nguyên này là bản lưu offline của các trang web tương ứng đề phòng các trang web này sập trong tương lai. Vì thế, dung lượng của các tài nguyên này rất lớn và chứa nhiều file. Việc đóng góp các tài nguyên này cần thông báo trực tiếp cho Văn Thành Duy và không thực hiện thông qua pull request.

Các tài liệu ôn tập, sách , tạp chí vật lý chính là các nội dung chính trên trang web, do dự án còn non trẻ về mặt thời gian, nên số lượng cũng như chất lượng các tài liệu vẫn còn nhiều hạn chế. Người dùng có thể đóng góp tài liệu dưới dạng :

• PDF - Thông qua pull request hoặc gửi Mail
• Word - doc, docx : Thông qua gửi Mail cho Văn Thành Duy, cá nhân Văn Thành Duy sẽ tự convert file sang PDF và đưa lên trang web
• epub - Thông qua gửi Mail cho Văn Thành Duy
• Ảnh - Thông qua gửi Mail cho Văn Thành Duy, tuy nhiên nên hạn chế nếu số lượng rất lớn, người dùng khi có số lượng tài liệu ở dạng ảnh lớn nên thông báo và trao đổi trực tiếp qua Mail

Người dùng gửi email cho Văn Thành Duy và trao đổi một cách bình thường, đính kèm tài liệu (tài liệu đính kèm trực tiếp nếu có dung lượng dưới 25 MB), nếu tài liệu có dung lượng vượt quá 25 MB thì phải được đưa lên Google Drive và người dùng gửi URL tới file qua mail.

Bước 1: Người dùng clone, tạo branch như hướng dẫn ở mục số 2 wiki

Bước 2: Người dùng đưa tệp tài liệu vào trong folder tương ứng của hạng mục

Bước 3: Chỉnh sửa danh sách tài liệu tương ứng của hạng mục

Bước 4: commit và push thay đổi lên branch cá nhân

Bước 5: Trở lại Github và tạo pull request, request sẽ được đánh giá và duyệt, nếu thông qua sẽ được merge vào branch chính.

Dưới đây là 1 ví dụ đóng góp 1 tài liệu tiếng anh:

Người dùng đang có một tài liệu tiếng anh (thật ra là tiếng Trung)

Người dùng xác định mục sách này là sách tiếng anh (thật ra là tiếng Trung 😉), trình độ của sách nằm ở trình độ sau vòng 2 Thành phố cho tới VPhO, vì thế sách sẽ thuộc về mục "Sách tiếng anh vòng 2 thành phố /HSGQG".

Copy và paste tệp PDF vào thư mục books

Sau đó, bổ sung thông tin của sách trong file txt tương ứng books-vpho-en.txt theo cú pháp Tên sách <br> Mô tả ngắn | Tên tác giả | Đường dẫn sách | Nhà xuất bản

Chinese Book <br> A book for PhO training | Unknown Author | /books/chinese_book.pdf | Không rõ

Sử dụng Source Control hoặc CLI để xác nhận lại thay đổi

Commit bằng nút "Commit", hoặc đối với CLI, sau khi đã xác nhận thay đổi

git commit -m "Đóng góp Chinese Books"
git push

Sau khi đã push thay đổi, quay trở lại Github và tạo pull request

Ấn Create pull request, sau đó yêu cầu sẽ được đánh giá và thông qua bởi Văn Thành Duy.

Khi đưa sách, tài liệu, file PDF vào thư mục physics, người dùng tuân theo quy tắc đường dẫn sau:

Cú pháp thêm sách vào file txt:

Sách : Tên sách <br> Mô tả ngắn | Tên tác giả | /books/<tên file>.pdf | Nhà xuất bản

Tài liệu và handout : Tên tài liệu <br> Mô tả ngắn | Tên tác giả | /materials/handouts/<tên file>.pdf

Đề và đáp án : Tên tài liệu <br> Mô tả ngắn | Tên nguồn | /materials/<tên file>.pdf

Tạp chí : Số tạp chí <br> Mô tả ngắn | Tên Nhà xuất bản | /materials/<tên tạp chí>/<tên số tạp chí>.pdf