1. Mục đích
Mục lục
Mục tiêu của bộ quy tắc ứng xử này là xây dựng một team nơi mà các thành viên đều tôn trọng lẫn nhau, luôn vui vẻ và đều được tạo điều kiện học hỏi và phát triển.
2. Phạm vi áp dụng
Quy tắc ứng xử này áp dụng với các thành viên tham gia dự án.
3. Kỳ vọng của team
Các thành viên trong team được kỳ vọng:
-
Luôn nỗ lực trong mọi hoạt động.
-
Hành xử đúng mực và tôn trọng những người xung quanh.
-
Khi gặp xung đột, cần bình tĩnh giải quyết.
-
Không ngại chia sẻ ý kiến của mình khi gặp vấn đề.
-
Tôn trọng ý kiến và niềm tin của người khác.
-
Đoàn kết giúp đỡ lẫn nhau.
-
Hoàn thành deadline được giao đúng hạn.
-
Tuân thủ các nguyên tắc khi code.
-
Luôn hướng đến việc code của mình có thể kế thừa được.
4. Hành vi không được chấp nhận
-
Trêu đùa, lăng mạ, xúc phạm người khác.
-
Bạo lực, đe dọa người khác.
-
Đánh cắp các thông tin cá nhân của người khác mà không được sự cho phép.
-
Các hành vi phi đạo đức hoặc không chuyên nghiệp khác.
5. Hậu quả của hành vi không được chấp nhận
-
Các trường hợp lạm dụng, quấy rối hoặc hành vi không thể chấp nhận có thể báo cáo bằng cách liên hệ với người quản lý dự án.
-
Người quản lý dự án có quyền và trách nhiệm xóa, chỉnh sửa hoặc từ chối comments, commits, code, chỉnh sửa wiki, issues và các đóng góp khác không phù hợp với Quy tắc ứng xử này.
-
Nếu hành vi gây hậu quả nghiêm trọng, có thể xem xét loại bỏ người thực hiện hành vi ra khỏi dự án.
-
Bằng cách áp dụng Quy tắc ứng xử này, những người quản lý dự án cam kết áp dụng một cách công bằng và nhất quán các nguyên tắc này cho mọi khía cạnh của dự án.
Contributing to project – Đóng góp vào dự án
1. Quy tắc ứng xử
Vui lòng đọc bộ quy tắc ứng xử tại đây.
2. Có câu hỏi hoặc vấn đề
Không nên mở issues cho các câu hỏi hỗ trợ chung vì git issues chỉ nên được sử dụng cho báo cáo bugs và yêu cầu các tính năng.
Chúng tôi khuyến khích sử dụng Stack Overflow, Google hoặc có thể liên hệ trực tiếp với leader để hỏi, tìm kiếm cách giải quyết các thắc mắc.
3. Phát hiện thấy Bug
Nếu bạn tìm thấy một bug trong source code, bạn có thể gửi lên một issue. Thậm chí, bạn có thể submit một bản fix và gửi merge request.
4. Yêu cầu tính năng
Bạn có thể yêu cầu một tính năng mới bằng cách gửi một issue. Nếu bạn muốn triển khai một tính năng mới, vui lòng xem xét quy mô của tính năng để xác định các bước phù hợp để tiến hành:
-
Đối với tính năng chính, trước tiên hãy mở một issue và phác thảo đề xuất của bạn để mọi người cùng thảo luận. Việc này cho phép nhóm phối hợp tốt hơn, ngăn chặn sự trùng lặp công việc và giúp cho tính năng có thể thêm vào dự án một cách thành công.
-
Đối với tính năng nhỏ, có thể code và gửi merge request.
4. Nguyên tắc khi submit
4.1 Submit một issue
Trước khi gửi một issue, vui lòng tìm kiếm trong danh sách issue trước đó, có thể issue của bạn đã tồn tại và đã được thảo luận.
Khi submit một issue, hãy mô tả rõ sự cố và chỉ ra các bước để dẫn đến sự cố đó để nhóm có thể xác định và xử lý sớm nhất có thể.
Bạn có thể tạo một issue tại đây.
4.2 Submit một merge request
-
Clone project về máy của bạn.
-
Tạo một nhánh mới.
Đối với nhánh dành cho tính năng:
git checkout -b feature/feature-nameĐối với nhánh fix bug:
git checkout -b fix/bug-name-
Thêm tính năng mới và đảm bảo hoạt động tốt, tuân thủ theo quy tắc và có thể kế thừa được.
-
Thêm các thay đổi của bạn với lệnh:
git add .hoặc
git add file_được_thay_đổiLưu ý: Không khuyến khích sử dụng lệnh “git add .” bởi vì có thể add những file không cần thiết hoặc các file tự sinh ra trong lúc debug.
* Mô tả các thay đổi bằng lệnh:
git commit -m "nội dung thay đổi"Có thể thao khảo lệnh git commit tại đây.
* Đẩy nhánh của bạn lên git:
git push origin tên_nhánh-
Cuối cùng là gửi merge request cho yêu cầu của bạn tại đây.
Các quy tắc khi code
Để đảm bảo tính nhất quán trong toàn bộ mã nguồn, hãy ghi nhớ các quy tắc này khi đang làm việc:
-
Tất cả các tính năng hoặc fix bug phải được test bằng unit test.
-
Tất cả API phải được lập documents.
-
Tuân theo quy tắc code của ngôn ngữ lập trình được sử dụng.
Tổng kết
Thank for watching!
Leave a Reply