V QUẢN LÝ CHẤT LƯỢNG 1 Quản lý chất lượng 1 1 Các quy định cho hệ thống Trong quá trình xây dựng và phát triển dự án này, các lập trình viên cần tuân thủ một số quy định sau Ngôn ngữ sử dụng để viết c[.]
V QUẢN LÝ CHẤT LƯỢNG 1.Quản lý chất lượng 1.1 Các quy định cho hệ thống Trong trình xây dựng phát triển dự án này, lập trình viên cần tuân thủ số quy định sau: ● Ngôn ngữ sử dụng để viết code: tiếng Anh (English) ● Ngôn ngữ sử dụng để viết comment: tiếng Việt ● Font chữ cho ứng dụng: ưu tiên font Segoe UI ● Color: tone màu ứng dụng bao gồm màu với mã grb [239,250,252] [32,172,210], ngồi sử dụng màu sắc khác Tuy nhiên nên hạn chế màu sắc ● Kích thước form: Ln cố gắng đảm bảo tỷ lệ : Form rộng cao để đảm bảo cân xứng với hình 1.1.1 Quy tắt đặt tên: a Các qui ước Quy ước được, quan trọng consistency (nhất quán) Kiểu Mô tả Ví dụ Pascal Case – Chữ từ định danh chữ từ nối theo sau phải viết hoa – Pascal Case sử dụng để đặt tên cho tên có từ ký tự trở lên GetUser Camel Case Chữ từ getUser định danh chữ thường chữ mối từ nối theo sau phải viết hoa Uppercase – Tất ký tự từ định danh GETUSER phải viết hoa – Sử dụng quy tắc tên định danh có từ ký tự trở xuống Nhóm sử dụng reactJS để phát triển Front-end nodeJS để phát triển Backend nên định sử dụng quy ước Camel Case b Tên hàm kiểu A/HC/LC Đối với tên hàm, có kiểu đặt tên phổ biến mà có lẽ bạn nhiều gặp qua Kiểu có dạng sau: Ví dụ: Một lưu ý quan trọng thứ tự chữ có ảnh hưởng đến ý nghĩa tên Ví dụ shouldUpdateComponent có nghĩa bạn người update component, đảo thứ tự thành shouldComponentUpdate, nghĩa component tự update, bạn kiểm sốt update thơi c Actions Động từ hành động hàm Đa số hàm bắt đầu action để diễn tả hàm làm Một số từ dùng làm action phổ biến: ● get: Truy xuất/lấy liệu ● set: Gán giá trị cho biến ● reset: Đặt lại giá trị/trạng thái ban đầu ● fetch: Gửi request để lấy liệu ● remove: Loại bỏ phần tử khỏi mảng, danh sách, tập hợp (cần lưu ý điểm khác biệt remove delete) ● delete: Xóa bỏ hoàn toàn tồn cá thể ● create: Tạo liệu ● handle: Xử lý kiện callback (ngồi handle on hay sử dụng) d Context Bối cảnh xử lý hàm e Prefixes Tiền tố giúp tăng ý nghĩa hàm/biến ● is: Mô tả đặc điểm trạng thái context (thường boolean) ● ● ● ● has: Xác định tồn trạng thái context (thường boolean) should: Thể điều kiện xảy hành động (thường boolean) min/max: Mô tả giới hạn context (thường numeric) prev/next: Thể chuyển từ trạng thái cũ sang trạng thái 1.1.2 Một số nguyên tắc a Nguyên tắc S - I - D ● Short (ngắn gọn): tên không dài, thời gian để gõ nhớ ● Intuitive (tự nhiên): tên đọc lên phải cho cảm giác xi tai, gần gũi với văn nói ● Descriptive (súc tích): tên phải mơ tả ý nghĩa, tác dụng nó, cách hiệu b Sử dụng template literal (template strings) để khai báo chuỗi Template literal thực chất string literal, cú pháp để khai báo chuỗi JavaScript Đây tính có ECMA6, cho phép embed biểu thức JavaScript bên chuỗi mà không cần dùng phép cộng c Dùng arrow function ES6 Khi viết biểu thức hàm (function) dùng arrow function có cú pháp ngắn gọn hơn, chúng hàm nặc danh thay đổi trỏ this bind đến functions d số dòng cho files functions Tuy dự án khác nên khó để thực điều này, cân nhắc thấy vài đoạn code trở nên phình to hơn, có kinh nghiệm bạn tìm độ dài phù hợp Ví dụ: ● files chứa tối đa 80 dòng code ● functions chứa tối đa 15 dòng code 1.1.3 Một số lưu ý ● Khi so sánh dùng === thay == ● Đừng dùng var mà dùng let: Lý đơn giản let xử lý vấn đề phạm vi (scoping issue) var JavaScript ● Dùng const thay cho let: Cái ngăn chặn dev thay đổi thứ không cần thiết giúp cải thiện readability ● Luôn dùng dấu chấm phẩy (;): Dù dấu chấm phẩy không bắt buộc JavaScript kết thúc câu lệnh ngôn ngữ khác, nhiên dùng ; giữ tính qn dịng code, giúp phân cách dòng lệnh ● Hạn chế nesting ○ If lồng if dễ gây nhầm lẫn khó để đọc ○ Ví dụ: ○ ○ Đổi thành ○ ● Tên file viết thường ○ MyFile.js nên để myFile.js ● Shorthand cho boolean ○ Ví dụ: ○ ○ Đổi thành ○ ● Hạn chế ternary statements không cần thiết ○ Ví dụ: ○ ○ Đổi thành ○ 1.2 Quy định viết comment ● Comment phải mô tả suy nghĩ người viết code giải đáp thắc mắc người đọc ● Những đoạn code phức tạp cần có comment gắn liền bên ● Không comment đoạn code mà ý nghĩa rõ ràng ● Đối với event: cần phải có mơ tả mục đích diễn giải ngắn gọn ý nghĩa tham số đầu vào, đầu Tuy nhiên, khơng cần viết phần mơ tả mục đích với method/event đơn giản, khơng phức tạp ● Đối với comment nằm dòng: Khi sử dụng comment dịng, khơng nên đặt comment bên phải dịng code gây khó đọc cho code comment bạn, đặc biệt dòng code dài ● Đối với comment nhiều dòng: vị trí đặt comment dịng nên để đầu file code, đầu hàm, phía bên hàm Do vị trí này, người đọc code nhìn thấy comment trước thấy phần code dễ dàng nắm bắt tư tưởng đoạn code phía sau ● Xố comment xoá code kèm, tránh dư thừa comment ● Các thành viên nên sử dụng tiếng Việt có dấu (Unicode) để viết comment 1.3 Công cụ quản lý source code: GitHub 1.3.1 Giới thiệu GitHub: Git trái tim GitHub lưu nhiều phiên mã nguồn thư viện cho phép tạo kho lưu trữ cục máy tính riêng Hub phần hồn, nơi biến đổi dòng lệnh thành mạng xã hội khổng lồ cho lập trình viên GitHub hệ thống quản lý dự án phiên code phát triển Linux Torvalds, hoạt động giống mạng xã hội cho lập trình viên Công cụ quản lý sử dụng chủ yếu cho dự án có nhiều người hợp tác, giám sát toàn thay đổi dự án khôi phục code cần thiết Đối với đặc điểm riêng biệt GitHub: có nhiều hai nhà phát triển phần mềm làm việc file mà họ muốn cập nhật đồng thời Nếu công cụ khác dropbox hệ thống điện tốn đám mây thường người lưu tệp ưu tiên người cịn lại Trong GitHub điều khơng vậy, cơng cụ có chế ghi lại thay đổi phản ánh chúng theo cách có tổ chức để tránh xung đột chồng chéo trùng lặp tệp tải lên Do đó, sử dụng kho lưu trữ tập trung GitHub tránh tất nhầm lẫn làm việc tập tin dự án trở nên dễ dàng ❖ Các bước khởi đầu để tạo repository GitHub: Các bước khởi đầu để tạo repository GitHub: Đầu tiên truy cập liên kết: https://github.com/ Điền vào biểu mẫu đăng ký nhấp vào “Sign up for Github” để tạo cho tài khoản Github Đăng nhập vào tài khoản GitHub bạn đăng ký Sử dụng dấu “+” bên phải để tạo repository Điền theo yêu cầu để tạo repository Cần lưu ý options sau: + Theo mặc định repository để public nghĩa xem repo Muốn quản lý nội chọn Private + Người dùng có thêm README file để giới thiệu repository kèm với file gitignore Github có sẵn template gitignore cho bạn, chọn template phù hợp với mã nguồn dự án Chọn “Create repository” Giao diện sau tạo xong repository Thêm người vào team để làm việc nhóm Chọn “Settings” sau chọn “Invite” để thêm thành viên Hiện để sử dụng GitHub, người dùng đơn giản sử dụng trực tiếp thông qua website: https://github.com/ tải công cụ máy để sử dụng 1.3.2 Quản lý mã nguồn Các repositories hiển thị trang cá nhân cho người Khi bạn chọn repository bất kì, hiển thị bao gồm source code, thành viên khách tham gia, mơ tả, để người dùng clone, push, pull source code Ngày trước điểm yếu tảng giới hạn người dùng tạo private repository Nhưng vào đầu 1/2019, theo thơng tin từ github blog người dùng tạo private repository miễn phí Ký hiệu ổ khóa thể cho private repository sách thể public repository 1.3.3.Lưu trữ đoạn mã GitHub hỗ trợ, cung cấp cho cộng đồng việc có public mã nguồn mở giúp người dùng chia sẻ tìm kiếm đoạn mã nguồn khác cộng đồng người tham gia GitHub cập nhật 1.4 Nguyên tắc "commit" git (Conventional commits) Các "commit" phải tuân thủ theo công thức để việc quản lý truy xuất vấn đề nhanh chóng rõ ràng fix: "commit" chuyên dùng để sửa lỗi mã nguồn bạn feat: "commit" dùng để phát triển tính chức BREAKING CHANGE: "commit" giới thiệu “breaking API change” Một “BREAKING CHANGE” phần “commit” Ví dụ: feat#2: add ability to parse arrays Trong “Feat” : biểu cho chức “2”: mã issue tạo danh sách công việc “add ability to parse arrays” : nội dung commit Việc áp dụng “conventional commits” giúp đỡ: ● Tự động tạo CHANGELOG ● Truyền đạt thay đổi nhỏ cho thành viên, công chúng bên liên quan khác ● Kích hoạt q trình xây dựng xuất ● Giúp người đóng góp cho dự án bạn dễ dàng cách cho phép họ khám phá lịch sử “commit” có cấu trúc