Add instructions how to build the samples

Đang mở
#188 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
java, shell
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với README.md và readme.html, sau đó kiểm tra các shell script được cung cấp và bố cục mẫu, đặc biệt là cách các tệp được yêu cầu đặt trong target và Maven được sử dụng như thế nào. Công việc được xem là hoàn tất khi một người mới có thể build các mẫu, hiểu liệu chúng có standalone hay không, và xác định mọi dependency giữa các module có thể cần phải có sẵn trong repository Maven cục bộ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

Provide more details how to build the code-samples in README.md or readme.html.

It's not obvious how to start with the code samples provided with Hazelcast. It's mainly important for people who didn't met Maven before.

The provided shell scripts don't build the sample themselves, they just expect the bits are ready in target directory.

Interdependencies
There is one more point related: it's not obvious if the samples are standalone or have some interdependecies. So if a user tries just one sample, it can experience dependency problems when another module (dependency) in not already in the local Maven repo.

Mention the possible cross-module dependenices in the readme too.

Ngôn ngữ chính
Java
Star
558
Fork
599
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của hazelcast/hazelcast-code-samples

Tất cả issue của hazelcast/hazelcast-code-samples

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.