Skip to content

Commit fad3124

Browse files
authored
Merge pull request #5 from tech-notes-hub/refactor/reorganize-structure-folder
🚀 Knowledge Base Expansion PR 📄 Description This PR adds new content to the Knowledge Base under: main It includes structured documentation, examples, and reference materials to support developer learning. 🔗 Related Issue 🆕 Content Type New topic/section Content enhancement Reference guide Tutorial/How-to Translation - Language: vi 📂 Content Structure Follows naming conventions Includes appropriate code examples Uses proper heading hierarchy Contains internal cross-references ✅ Quality Checklist Content follows project style guidelines Reviewed for accuracy and clarity Includes relevant references/citations All links and examples have been tested Translation follows i18n standards (if applicable) 📝 Additional Notes
2 parents 55c9efc + 3f68001 commit fad3124

File tree

90 files changed

+23428
-25
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+23428
-25
lines changed

.editorconfig

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Default settings for all files
7+
[*]
8+
charset = utf-8
9+
end_of_line = lf
10+
insert_final_newline = true
11+
trim_trailing_whitespace = true
12+
indent_style = space
13+
indent_size = 2
14+
15+
# Markdown files
16+
[*.{md,markdown}]
17+
trim_trailing_whitespace = false # Trailing whitespace is significant in Markdown
18+
19+
# Python files
20+
[*.py]
21+
indent_size = 4
22+
max_line_length = 88 # Black formatter default
23+
24+
# C# files
25+
[*.cs]
26+
indent_size = 4
27+
csharp_new_line_before_open_brace = all
28+
csharp_space_between_method_declaration_parameter_list_parentheses = false
29+
csharp_space_between_method_call_parameter_list_parentheses = false
30+
csharp_space_after_keywords_in_control_flow_statements = true
31+
csharp_space_between_parentheses = false
32+
33+
# JavaScript/TypeScript files
34+
[*.{js,ts,jsx,tsx}]
35+
quote_type = single
36+
37+
# JSON files
38+
[*.json]
39+
insert_final_newline = false
40+
41+
# YAML files
42+
[*.{yml,yaml}]
43+
indent_size = 2
44+
45+
# Shell scripts
46+
[*.sh]
47+
indent_size = 2
48+
49+
# HTML, CSS, SCSS files
50+
[*.{html,css,scss}]
51+
indent_size = 2
52+
53+
# Java files
54+
[*.java]
55+
indent_size = 4
56+
57+
# Go files
58+
[*.go]
59+
indent_style = tab
60+
indent_size = 4
61+
62+
# Makefiles
63+
[Makefile]
64+
indent_style = tab

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Additional context**
27+
Add any other context about the problem here.
28+
29+
**Possible solution**
30+
If you have suggestions on how to fix the issue, please describe them here.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Báo cáo lỗi
3+
about: Tạo một báo cáo lỗi để giúp chúng tôi cải thiện
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Mô tả lỗi**
11+
Mô tả ngắn gọn và rõ ràng về lỗi đang gặp phải.
12+
13+
**Cách để tái tạo lỗi**
14+
Các bước để tái hiện hành vi lỗi:
15+
1. Truy cập vào '...'
16+
2. Nhấn vào '...'
17+
3. Cuộn xuống tới '...'
18+
4. Thấy lỗi
19+
20+
**Hành vi mong đợi**
21+
Mô tả rõ ràng và ngắn gọn về điều bạn mong đợi sẽ xảy ra.
22+
23+
**Ảnh chụp màn hình**
24+
Nếu có, hãy thêm ảnh chụp màn hình để minh họa lỗi.
25+
26+
**Ngữ cảnh bổ sung**
27+
Thêm bất kỳ thông tin bổ sung nào về sự cố ở đây (thiết bị, trình duyệt, môi trường...).
28+
29+
**Giải pháp khả thi**
30+
Nếu bạn có gợi ý về cách khắc phục lỗi, vui lòng mô tả tại đây.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.
21+
22+
**Target topics/areas**
23+
Which topics or sections of the repository would be affected by this feature?
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Yêu cầu tính năng
3+
about: Đề xuất một ý tưởng hoặc tính năng cho dự án
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Yêu cầu tính năng này có liên quan đến vấn đề nào không? Hãy mô tả.**
11+
Mô tả rõ ràng và ngắn gọn về vấn đề. Ví dụ: Tôi thường cảm thấy khó chịu khi [...]
12+
13+
**Mô tả giải pháp bạn muốn có**
14+
Mô tả rõ ràng và ngắn gọn về điều bạn muốn xảy ra.
15+
16+
**Mô tả các giải pháp thay thế bạn đã xem xét**
17+
Mô tả rõ ràng và ngắn gọn về bất kỳ giải pháp thay thế hoặc tính năng khác mà bạn đã cân nhắc.
18+
19+
**Ngữ cảnh bổ sung**
20+
Thêm bất kỳ thông tin, bối cảnh hoặc ảnh chụp màn hình nào liên quan đến yêu cầu tính năng ở đây.
21+
22+
**Các chủ đề/khu vực bị ảnh hưởng**
23+
Những chủ đề hoặc phần nào trong repository sẽ bị ảnh hưởng bởi tính năng này?

.github/workflows/ci.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Markdown CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
check-links:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Setup Node.js
16+
uses: actions/setup-node@v3
17+
with:
18+
node-version: '16'
19+
20+
- name: Install dependencies
21+
run: npm install -g markdown-link-check
22+
23+
- name: Check links
24+
run: ./tools/check_links.sh
25+
26+
- name: Generate TOC
27+
run: |
28+
python3 ./tools/generate_summary.py
29+
git diff --exit-code SUMMARY.md || (echo "SUMMARY.md is out of date. Please run ./tools/generate_summary.py and commit the changes" && exit 1)

.gitignore

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,34 @@ node_modules/
33

44
# Python
55
__pycache__/
6-
*.pyc
7-
*.pyo
8-
*.pyd
9-
.env
10-
.venv/
6+
*.py[cod]
7+
*$py.class
8+
*.so
9+
.Python
10+
env/
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
*.egg-info/
23+
.installed.cfg
24+
*.egg
25+
26+
# C#
27+
bin/
28+
obj/
29+
*.user
30+
*.suo
31+
*.userprefs
32+
*.sln.docstates
33+
.vs/
1134

1235
# VSCode settings
1336
.vscode/
@@ -42,6 +65,8 @@ coverage.xml
4265
# dotenv environment files
4366
.env.local
4467
.env.*
68+
.env
69+
!.env.example
4570

4671
# Ignore generated files and backups
4772
*.orig

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Tech Notes Hub
22

3-
First of all, thank you for taking the time to contribute! 🎉
3+
First of all, thank you for taking the time to contribute! 🎉
44
Your contributions help make this project more valuable for the developer community.
55

66
## 🚀 Ways to Contribute
@@ -74,14 +74,15 @@ Write clear, meaningful, and understandable commit messages. Suggested structure
7474
- `feature: add notes on HTTP Status Codes`
7575
- `fix: correct typos in design-patterns.md`
7676
- `update: improve binary search examples`
77+
- `refactor: reorganize folder structure`
7778
- `remove: delete duplicate notes in aws folder`
7879
- `docs: add instructions for creating pull requests`
7980

8081
#### 🧠 Additional Tips:
8182

8283
- You can only write in **English**
8384
- **Avoid vague commits** like: `update 1`, `fix bug`, `test`
84-
- If related to an issue, add the number at the end:
85+
- If related to an issue, add the number at the end:
8586
👉 `fix: typo in aws-note #12`
8687

8788
### 5. Commit & Push
@@ -111,9 +112,9 @@ Before submitting, ensure:
111112

112113
## 📁 File & Folder Naming Conventions
113114

114-
* Use lowercase and hyphens for file and folder names: `graph-traversal.md`
115-
* For translations, add language suffix: `graph-traversal_vi.md`
116-
* Notes should be grouped by topic folders (e.g., `algorithms/`, `aws/`, `design-patterns/`)
115+
* Use lowercase and hyphens for file and folder names: `graph_traversal.md` (except for code files like C# using PascalCase such as `GraphTraversal.cs`, or Java using CamelCase like `GraphTraversal.java`)
116+
* For translations, add language suffix: `graph_traversal_vi.md`
117+
* Notes should be grouped by docs folders (e.g., `docs/algorithms/`, `docs/aws/`, `docs/design-patterns/`)
117118

118119
## 🤝 Code of Conduct
119120

CONTRIBUTING_vi.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Đóng góp vào Tech Notes Hub
22

3-
Trước hết, xin chân thành cảm ơn bạn đã dành thời gian đóng góp! 🎉
3+
Trước hết, xin chân thành cảm ơn bạn đã dành thời gian đóng góp! 🎉
44
Sự đóng góp của bạn giúp dự án này trở nên hữu ích hơn cho cộng đồng lập trình viên.
55

66
## 🚀 Cách bạn có thể đóng góp
@@ -74,14 +74,15 @@ Viết commit rõ ràng, có ý nghĩa và dễ hiểu. Cấu trúc đề xuất
7474
- `feature: add notes on HTTP Status Codes`
7575
- `fix: correct typos in design-patterns.md`
7676
- `update: improve binary search examples`
77+
- `refactor: reorganize folder structure`
7778
- `remove: delete duplicate notes in aws folder`
7879
- `docs: add instructions for creating pull requests`
7980

8081
#### 🧠 Gợi ý thêm:
8182

8283
- Bạn chỉ có thể viết bằng **tiếng Anh**
8384
- **Tránh commit mơ hồ** như: `update 1`, `fix bug`, `test`
84-
- Nếu liên quan issue, thêm số vào cuối:
85+
- Nếu liên quan issue, thêm số vào cuối:
8586
👉 `fix: typo in aws-note #12`
8687

8788

@@ -112,9 +113,9 @@ Trước khi gửi, hãy đảm bảo:
112113

113114
## 📁 Quy tắc đặt tên file & thư mục
114115

115-
* Tên file và thư mục dùng chữ thường và dấu gạch ngang: `graph-traversal.md`
116-
* Nếu là bản dịch, thêm hậu tố ngôn ngữ: `graph-traversal_vi.md`
117-
* Ghi chú nên được nhóm theo thư mục chuyên đề (ví dụ: `algorithms/`, `aws/`, `design-patterns/`)
116+
* Tên file và thư mục dùng chữ thường và dấu gạch ngang: `graph_traversal.md` (trừ code như C# sử dụng PascalCase như `GraphTraversal.cs`, hoặc Java sử dụng CamelCase như `GraphTraversal.java`)
117+
* Nếu là bản dịch, thêm hậu tố ngôn ngữ: `graph_traversal_vi.md`
118+
* Ghi chú nên được nhóm theo thư mục trong docs (ví dụ: `docs/algorithms/`, `docs/aws/`, `docs/design-patterns/`)
118119

119120
## 🤝 Quy tắc ứng xử
120121

0 commit comments

Comments
 (0)