Skip to content

Commit 3957e55

Browse files
committed
add contribute.md
1 parent 5695519 commit 3957e55

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Donate? Muốn hỗ trợ mình 1 ly cafe <3 [Donate here](https://github.com/Ho
99
- Xem danh sách chức năng [Tại đây](./md/LIST_SCRIPTS_VI.md)
1010
- View list scripts [Here](./md/LIST_SCRIPTS_EN.md)
1111

12+
## Contribute - Đóng góp công sức của bạn
13+
14+
Contribute [tại đây (vietnamese)](/md/CONTRIBUTE.md)
15+
1216
## How to install
1317

1418
- Chrome Webstore - Coming soon...

md/CONTRIBUTE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Useful script - Contribute
2+
3+
## Cấu trúc thư mục:
4+
5+
- [scripts/](/scripts/) : Chứa tất cả các scripts chức năng của extension
6+
- [popup/](/popup/) : Chứa code giao diện, logic hiển thị giao diện của trang popup (khi click extension)
7+
- [pages/](/pages/) : Chứa các pages hỗ trợ *(Trang xem mã nguồn script, Trang cài đặt cho extension)*
8+
9+
## Các cách contribute
10+
11+
### Cách 1: Thêm scripts của bạn:
12+
13+
Nếu bạn có 1 `script hay`, hoặc `bookmarklets hay`, muốn `thêm vào extension` để mọi người cùng sử dụng. Hãy làm theo các bước sau:
14+
15+
1. Tạo 1 file javascript mới trong folder [scripts/](/scripts/), với `tên file mô tả ngắn gọn` chức năng script của bạn.
16+
17+
2. Sao chép nội dung file [empty_script.js](/empty_script.js) và dán vào file vừa tạo.
18+
19+
3. Ghi nội dung script:
20+
- `Icon`: icon hiển thị script, có thể là link ảnh, hoặc dùng fontawsome (ví dụ `<i class="fa-regular fa-id-card"></i>`)
21+
- `Name``Description`: tên và mô tả script *(cả tiếng anh `en` và tiếng việt `vi`)*
22+
- `Blacklist`: Danh sách url các trang web mà script không hỗ trợ.
23+
- `Whitelist`: Danh sách url các trang web và script hỗ trợ
24+
- *Ghi chú: Để mảng rỗng cả `Blacklist``Whitelist` nếu script của bạn **hỗ trợ mọi trang web**.*
25+
- Thêm code javascript của bạn vào `func`.
26+
27+
4. Import script của bạn trong file [/scripts/index.js](/scripts/index.js)
28+
29+
5. Ghi tên script của bạn trong biến `tabs` trong file [/popup/tabs.js](/popup/tabs.js)
30+
31+
6. Mở extension lên và dùng thử.
32+
33+
34+
### Cách 2: Chỉnh sửa script có sẵn
35+
36+
Nếu bạn thấy `script` nào trong danh sách hiện có `bị lỗi` hoặc `có thể nâng cấp`. và bạn muốn sửa nó, chỉ cần mở đúng `file tương ứng` của chức năng đó trong folder [scripts/](/scripts/) để chỉnh sửa.
37+
38+
### Cách 3: Cập nhập logic chính
39+
40+
Nếu bạn có nhiều thời gian hơn để vọc code extension, và muốn `chỉnh sửa logic chính` của mình để `sửa lỗi` hoặc `nâng cấp`. Hãy
41+
42+
### Cách 4: Dịch
43+
44+
Bạn có thể giúp mình `dịch` các trang hướng dẫn này sang tiếng anh, hoặc bất kỳ ngôn ngữ mà bạn muốn.
45+
46+
## Liên hệ
47+
48+
Gmail: 99.hoangtran@gmail.com
49+
50+
Facebook: [fb.com/99.hoangtran](https://fb.com/99.hoangtran)

0 commit comments

Comments
 (0)