Tài liệu này ban đầu là đã đăng trên Habr.com bằng tiếng Nga. Tác giả đã cho phép nó được dịch và xuất bản trên Codingsight.
Có lẽ, ai cũng có ở đâu đó một tập tin để lưu giữ những điều thú vị và hữu ích, chẳng hạn như liên kết đến các bài báo, sách, kho lưu trữ, sách hướng dẫn, v.v. Bạn có thể sử dụng dấu trang trong trình duyệt hoặc các tab, vẫn đang mở và chờ đợi bạn. Theo thời gian, tất cả đều phát triển quá mức, các liên kết bị phá vỡ và các vật liệu trở nên lỗi thời.
Nhưng điều gì sẽ xảy ra nếu chúng ta có thể chia sẻ những viên ngọc sâu sắc này với cộng đồng? Tải tệp lên GitHub? Sau đó, phát hiện của bạn sẽ hữu ích cho người khác. Bên cạnh đó, việc cập nhật tệp cùng nhau sẽ dễ dàng hơn, cập nhật danh sách thông qua các yêu cầu kéo cũ tốt.
Đây là những gì chúng tôi có dự án Danh sách tuyệt vời.
Awesome Lists nằm trong số 10 kho lưu trữ GitHub hàng đầu, tự hào đã có 138k “sao” và một liên kết đến các tác phẩm của bạn có thể đưa nó tới README gốc, do đó thu hút lượng lớn khán giả. Tuy nhiên, bạn sẽ phải nỗ lực trước. Ở đây, tôi muốn chia sẻ kinh nghiệm của mình.
Tôi là Maksim Gramin, một nhà phát triển Java và nhà nghiên cứu cơ sở dữ liệu tại CROC, một công ty CNTT quốc tế có trụ sở tại Moscow. Bài viết này sẽ cho bạn biết về Danh sách tuyệt vời và cách tạo repo tuyệt vời chính thức của bạn.
Giới thiệu về các danh sách tuyệt vời là gì?
Bất cứ khi nào tôi phải đối phó với một số công nghệ mới hoặc một ngôn ngữ lập trình, tôi đến đó trước tiên, tìm kiếm phần cần thiết và danh sách thích hợp. Với số lượng “ngôi sao” lớn và không ngừng tăng lên, tôi không phải là người duy nhất có cách tiếp cận như vậy.
Trên thực tế, “Danh sách tuyệt vời” là một readme.md đơn giản tiêu chuẩn sống trong một kho lưu trữ riêng biệt. Tuy nhiên, nó chiếm vị trí thứ 8 trong số tất cả các kho lưu trữ GitHub và bao gồm các danh sách khác dành riêng cho các chủ đề nhất định. Ví dụ:phần Ngôn ngữ lập trình có danh sách Awesome Python và Awesome Go, trong khi phần Front-End Development lưu trữ nhiều tài liệu phát triển Web. Cuối cùng nhưng không kém phần quan trọng, là phần Cơ sở dữ liệu (chúng ta sẽ nói về nó một chút sau).
Tất nhiên, nội dung không chỉ giới hạn ở các chủ đề kỹ thuật và còn bao gồm các phần khác, chẳng hạn như Giải trí và Trò chơi. Bạn cũng có thể tìm thấy nhiều điều thú vị ở đó (Tôi thực sự hài lòng với danh sách tuyệt vời-tưởng tượng).
Điểm khác biệt chính của dự án là tất cả các danh sách này không chỉ được quản lý bởi tác giả mà là cộng đồng. Bên cạnh đó, tất cả chúng đều được thực hiện theo một Tuyên ngôn tuyệt vời nghiêm ngặt. Mỗi danh sách đại diện cho một cộng đồng các chuyên gia riêng biệt, sống cuộc sống của riêng mình và cởi mở với các yêu cầu kéo của bạn, điều này sẽ làm cho nó thậm chí còn tốt hơn. Hơn nữa, bất kỳ ai cũng có thể tạo danh sách của riêng mình trong trường hợp chủ đề nào đó không được khám phá.
Đối với ý tưởng ban đầu và sự phối hợp tất cả những thứ này, chúng ta nên biết ơn huyền thoại Sindre Sorhus, người đàn ông đầu tiên trên GitHub và là tác giả của hơn 1.000 mô-đun npm. Anh ấy là người sẽ chấp nhận các yêu cầu kéo của bạn.
Cách tạo danh sách tuyệt vời
Nếu bạn chưa tìm thấy danh sách phù hợp cho chủ đề cần thiết, thì đó là dấu hiệu đầu tiên cho thấy bạn nên tự làm việc đó! Tôi sẽ cho bạn biết cách thực hiện điều đó bằng ví dụ do chính tôi tạo - Công cụ cơ sở dữ liệu tuyệt vời.
Từng dự án, tôi phải xử lý tất cả các loại cơ sở dữ liệu. Vì vậy, tôi bắt đầu quản lý một số tệp nơi tôi thu thập các công cụ hữu ích khác nhau cho công việc. Có nhiều trình di chuyển DB, IDE, bảng quản trị, công cụ giám sát, v.v., bao gồm cả những công cụ tôi đã sử dụng hoặc chỉ dự định sử dụng.
Tôi đã chia sẻ tệp này với các đồng nghiệp của mình tại CROC và hơn thế nữa, được khuyến khích khi thấy nó mang lại lợi ích cho nhiều người trong số họ như thế nào. Sau đó, tôi muốn nhiều hơn nữa. Khi tôi nhận thấy rằng phần Cơ sở dữ liệu thiếu danh sách dành riêng cho các công cụ, tôi quyết định thêm phần của tôi.
Bạn cần gì cho điều đó?
- Đăng ký một repo GitHub tiêu chuẩn và đặt tên nó là awesome-smth - trong trường hợp của tôi, đó là công cụ cơ sở dữ liệu tuyệt vời.
- Điều chỉnh danh sách thành tuyệt vời định dạng bằng cách sử dụng trình tạo-awesome-list sẽ tạo tất cả các tệp cần thiết ở định dạng phù hợp.
- Định cấu hình tích hợp liên tục (CI) - awesome-lint và Travis CI sẽ giúp chúng tôi kiểm soát tính hợp lệ của danh sách.
- Chờ trong 30 ngày.
- Xem xét ít nhất 2 yêu cầu kéo khác.
- Thực hiện một yêu cầu kéo tới repo chính và thêm liên kết đến repo của chính chúng tôi. Quan trọng :Đọc kỹ tất cả các yêu cầu trong danh sách mới và kéo các yêu cầu, đồng thời làm theo chúng một cách chính xác.
Nỗ lực đầu tiên của tôi không thành công.
Tuy nhiên, sau một thời gian, tôi đã thu thập thêm tài liệu, làm bài tập về nhà, sửa lỗi và thử lại lần thứ hai.
Nhưng tôi đã quên một điều quan trọng, và họ đã nhắc nhở tôi về điều đó một cách lịch sự:
Tôi đã không đủ chú ý và không thêm một con kỳ lân để xác nhận rằng tất cả các điều kiện đã được hoàn thành.
Một thời gian nữa trôi qua, tôi có thêm một số nhận xét và bổ sung sửa đổi, và cuối cùng, tôi thấy một thông báo được chờ đợi từ lâu rằng PR của tôi đã được chấp nhận.
Đây là cách tôi lập danh sách đầu tiên và bắt đầu nhận được các yêu cầu kéo của cộng đồng về việc thêm các công cụ mới. Nhiều người trong số họ đã được đưa vào Công cụ cơ sở dữ liệu tuyệt vời.
Nếu bạn có ý tưởng hay cho cơ sở dữ liệu - hãy chia sẻ chúng. Ngoài ra, tôi rất vui khi nhận được phản hồi từ bạn, chẳng hạn như yêu cầu kéo và dấu sao. Nếu bạn có bất kỳ câu hỏi nào về việc lập danh sách của riêng mình, vui lòng cho tôi biết.
Bạn có thể liên hệ với tác giả tại [email protected].
