InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Proposal: Renaming "Patlet" to "Summary"
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- HTML
- Star
- 853
- Fork
- 206
- Merge trung bình
- 1 ngày 23 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
In our pattern template we have a section called Patlet. We define it as:
Concise 1-2 sentence description of the problem and solution. Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns. http://wiki.c2.com/?PatLet
However many readers find this confusing, as Patlet is no real word in Englisch, and does not have an intuitive meaning. So while the word Patlet is kind of cute, and maybe fun for some of us (hardcore pattern nerds that is :)), it is not very helpful for the average consumer of our patterns.
Therefore I propose to replace the word Patlet by Summary instead.
Here is how I propose to change the definition in the pattern template.
-## Patlet
+## Summary
-Concise 1-2 sentence description of the problem and solution.
-Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns.
-From http://wiki.c2.com/?PatLet
+Concise summary of the pattern.
+Use the first sentence to describe the **problem**, the second sentence to describe the **solution**.
+Readers may quickly review dozens of these summaries to discover and browse our library of patterns.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Tìm “Patlet” trong các template của pattern và nội dung repository, đồng thời xem lại cách diễn đạt được đề xuất trong issue. Cập nhật tiêu đề và định nghĩa để sử dụng “Summary”, sau đó xác minh rằng thuật ngữ cũ không còn xuất hiện ở nơi template được sử dụng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- markdown
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 42/100