From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS4713 221.184.0.0/13 X-Spam-Status: No, score=-4.1 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from neon.ruby-lang.org (neon.ruby-lang.org [221.186.184.75]) by dcvr.yhbt.net (Postfix) with ESMTP id E6F821F770 for ; Mon, 31 Dec 2018 14:38:22 +0000 (UTC) Received: from neon.ruby-lang.org (localhost [IPv6:::1]) by neon.ruby-lang.org (Postfix) with ESMTP id 592781214C9; Mon, 31 Dec 2018 23:38:19 +0900 (JST) Received: from o1678948x4.outbound-mail.sendgrid.net (o1678948x4.outbound-mail.sendgrid.net [167.89.48.4]) by neon.ruby-lang.org (Postfix) with ESMTPS id BD49D1214C1 for ; Mon, 31 Dec 2018 23:38:14 +0900 (JST) Received: by filter0030p3las1.sendgrid.net with SMTP id filter0030p3las1-21395-5C2A29D2-C 2018-12-31 14:38:10.202024678 +0000 UTC m=+922264.066670564 Received: from herokuapp.com (ec2-54-234-121-56.compute-1.amazonaws.com [54.234.121.56]) by ismtpd0014p1iad2.sendgrid.net (SG) with ESMTP id zaAF8r7oQNiryuBQzttzGg for ; Mon, 31 Dec 2018 14:38:10.103 +0000 (UTC) Date: Mon, 31 Dec 2018 14:38:11 +0000 (UTC) From: mail@janlelis.de To: ruby-core@ruby-lang.org Message-ID: References: Mime-Version: 1.0 X-Redmine-MailingListIntegration-Message-Ids: 66259 X-Redmine-Project: ruby-trunk X-Redmine-Issue-Id: 15486 X-Redmine-Issue-Author: zverok X-Redmine-Issue-Assignee: hsbt X-Redmine-Sender: rbjl X-Mailer: Redmine X-Redmine-Host: bugs.ruby-lang.org X-Redmine-Site: Ruby Issue Tracking System X-Auto-Response-Suppress: All Auto-Submitted: auto-generated X-SG-EID: ync6xU2WACa70kv/Ymy4QrNMhiuLXJG8OTL2vJD1yS6H9MwfGTBVwHaRCb6siLEGqoUSR0imuSXV2O EtCWQN9/BFDHzM8GZSletO7LKoitlAm+JP/Ei/UovnLGmdjPG5KDfh6otCni6lzMOOFNu/CUqzhyR3 a9rspv81+H81FinEMLmZU5EdvUycXZae966P X-ML-Name: ruby-core X-Mail-Count: 90837 Subject: [ruby-core:90837] [Ruby trunk Misc#15486] Default gems README.md X-BeenThere: ruby-core@ruby-lang.org X-Mailman-Version: 2.1.15 Precedence: list Reply-To: Ruby developers List-Id: Ruby developers List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ruby-core-bounces@ruby-lang.org Sender: "ruby-core" Issue #15486 has been updated by rbjl (Jan Lelis). I'd like to help out, too. Maybe we can have a second file `README-DEFAULT-GEM.md` which is linked to by the `README.md`. The `README-DEFAULT-GEM` would explain how default gems work etc. and would be same for all default gems and would be updated in an automated way (i.e. one script that updates all). The README would then only contain gem specific examples, explanations, etc. ---------------------------------------- Misc #15486: Default gems README.md https://bugs.ruby-lang.org/issues/15486#change-76020 * Author: zverok (Victor Shepelev) * Status: Assigned * Priority: Normal * Assignee: hsbt (Hiroshi SHIBATA) ---------------------------------------- While working on [Ruby Changelog](https://bugs.ruby-lang.org/issues/15485), I noticed the following. A lot of parts of stdlib is extracted currently into "default gems". This, in my understanding, means (amongst other things) their development is now in separate repositories on GitHub, and their development is semi-independent. The problem I'd like to emphasize is **their README is unclear** about "what is it". Let's look at ostruct for example: https://github.com/ruby/ostruct. There are two huge problems: * Stumbling upon this repo, how should one know it is a) a part of Ruby stdlib? and b) the authoritative source of this part (and not a mirror of the code in ruby/ruby repo)? * There is some basic documentation explaining the usage of the library, but it would NOT be rendered anywhere in the standard library docs, so it is basically useless (which is not obvious for repo contributors). I believe that for standard library gems the README should look somehow as following: > This is the development repository of Ruby `ostruct` (`OpenStruct`) standard library. > > The library provides an `OpenStruct` data structure, similar to a `Hash`, that allows the definition of arbitrary attributes with their accompanying values. > > Canonical library docs: [OpenStruct](https://ruby-doc.org/stdlib-2.6/libdoc/ostruct/rdoc/OpenStruct.html) > > Before participating in the development of `ostruct`, you should know the following: > * The development process is standard "fork => commit => pull request" > * New versions of the standard library are released with new versions of Ruby > * Versioning policy: ... > * Code quality policy: ... > The last two points should probably link to the common documentation for all "default gems"... Well, as well as the whole text. So, all in all, there should be README template, where only gem names, short descriptions, and links to "canonical docs" are different (and maybe some code structure/contribution details for bigger libraries). WDYT? -- https://bugs.ruby-lang.org/