Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# Default settings for all files
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

# Markdown files
[*.{md,markdown}]
trim_trailing_whitespace = false # Trailing whitespace is significant in Markdown

# Python files
[*.py]
indent_size = 4
max_line_length = 88 # Black formatter default

# C# files
[*.cs]
indent_size = 4
csharp_new_line_before_open_brace = all
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_between_parentheses = false

# JavaScript/TypeScript files
[*.{js,ts,jsx,tsx}]
quote_type = single

# JSON files
[*.json]
insert_final_newline = false

# YAML files
[*.{yml,yaml}]
indent_size = 2

# Shell scripts
[*.sh]
indent_size = 2

# HTML, CSS, SCSS files
[*.{html,css,scss}]
indent_size = 2

# Java files
[*.java]
indent_size = 4

# Go files
[*.go]
indent_style = tab
indent_size = 4

# Makefiles
[Makefile]
indent_style = tab
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.

**Possible solution**
If you have suggestions on how to fix the issue, please describe them here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_vi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Báo cáo lỗi
about: Tạo một báo cáo lỗi để giúp chúng tôi cải thiện
title: '[BUG] '
labels: 'bug'
assignees: ''

---

**Mô tả lỗi**
Mô tả ngắn gọn và rõ ràng về lỗi đang gặp phải.

**Cách để tái tạo lỗi**
Các bước để tái hiện hành vi lỗi:
1. Truy cập vào '...'
2. Nhấn vào '...'
3. Cuộn xuống tới '...'
4. Thấy lỗi

**Hành vi mong đợi**
Mô tả rõ ràng và ngắn gọn về điều bạn mong đợi sẽ xảy ra.

**Ảnh chụp màn hình**
Nếu có, hãy thêm ảnh chụp màn hình để minh họa lỗi.

**Ngữ cảnh bổ sung**
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...).

**Giải pháp khả thi**
Nếu bạn có gợi ý về cách khắc phục lỗi, vui lòng mô tả tại đây.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

**Target topics/areas**
Which topics or sections of the repository would be affected by this feature?
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_vi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Yêu cầu tính năng
about: Đề xuất một ý tưởng hoặc tính năng cho dự án
title: '[FEATURE] '
labels: 'enhancement'
assignees: ''

---

**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ả.**
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 [...]

**Mô tả giải pháp bạn muốn có**
Mô tả rõ ràng và ngắn gọn về điều bạn muốn xảy ra.

**Mô tả các giải pháp thay thế bạn đã xem xét**
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.

**Ngữ cảnh bổ sung**
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.

**Các chủ đề/khu vực bị ảnh hưởng**
Những chủ đề hoặc phần nào trong repository sẽ bị ảnh hưởng bởi tính năng này?
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Markdown CI

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '16'

- name: Install dependencies
run: npm install -g markdown-link-check

- name: Check links
run: ./tools/check_links.sh

- name: Generate TOC
run: |
python3 ./tools/generate_summary.py
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)
35 changes: 30 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,34 @@ node_modules/

# Python
__pycache__/
*.pyc
*.pyo
*.pyd
.env
.venv/
*.py[cod]
*$py.class
*.so
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# C#
bin/
obj/
*.user
*.suo
*.userprefs
*.sln.docstates
.vs/

# VSCode settings
.vscode/
Expand Down Expand Up @@ -42,6 +65,8 @@ coverage.xml
# dotenv environment files
.env.local
.env.*
.env
!.env.example

# Ignore generated files and backups
*.orig
Expand Down
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Tech Notes Hub

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

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

#### 🧠 Additional Tips:

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

### 5. Commit & Push
Expand Down Expand Up @@ -111,9 +112,9 @@ Before submitting, ensure:

## 📁 File & Folder Naming Conventions

* Use lowercase and hyphens for file and folder names: `graph-traversal.md`
* For translations, add language suffix: `graph-traversal_vi.md`
* Notes should be grouped by topic folders (e.g., `algorithms/`, `aws/`, `design-patterns/`)
* 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`)
* For translations, add language suffix: `graph_traversal_vi.md`
* Notes should be grouped by docs folders (e.g., `docs/algorithms/`, `docs/aws/`, `docs/design-patterns/`)

## 🤝 Code of Conduct

Expand Down
11 changes: 6 additions & 5 deletions CONTRIBUTING_vi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Đóng góp vào Tech Notes Hub

Trước hết, xin chân thành cảm ơn bạn đã dành thời gian đóng góp! 🎉
Trước hết, xin chân thành cảm ơn bạn đã dành thời gian đóng góp! 🎉
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.

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

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

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


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

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

* Tên file và thư mục dùng chữ thường và dấu gạch ngang: `graph-traversal.md`
* Nếu là bản dịch, thêm hậu tố ngôn ngữ: `graph-traversal_vi.md`
* Ghi chú nên được nhóm theo thư mục chuyên đề (ví dụ: `algorithms/`, `aws/`, `design-patterns/`)
* 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`)
* Nếu là bản dịch, thêm hậu tố ngôn ngữ: `graph_traversal_vi.md`
* Ghi chú nên được nhóm theo thư mục trong docs (ví dụ: `docs/algorithms/`, `docs/aws/`, `docs/design-patterns/`)

## 🤝 Quy tắc ứng xử

Expand Down
Loading