From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: Naming guidelines for ELPA packages Date: Sat, 20 May 2023 16:51:01 +0000 Message-ID: <87sfbr7xqi.fsf@posteo.net> References: <87ttwjbfqq.fsf@gmail.com> <83y1lv5qe9.fsf@gnu.org> <0c04d76f-cca9-8a33-14fe-b9ad96a2b9aa@gmail.com> <87ednjicc0.fsf@posteo.net> <99eafa86-f7fc-8386-cdb4-a9fd706a42a3@gmail.com> <87ttwehfn3.fsf@posteo.net> <87a5y1hreg.fsf@disroot.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="13255"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Jim Porter , rms@gnu.org, eliz@gnu.org, relekarpayas@gmail.com, susam.pal@gmail.com, emacs-devel@gnu.org To: Akib Azmain Turja Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat May 20 18:51:50 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1q0Po4-0003GD-O8 for ged-emacs-devel@m.gmane-mx.org; Sat, 20 May 2023 18:51:48 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q0PnP-0002BB-G3; Sat, 20 May 2023 12:51:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q0PnO-00028a-A4 for emacs-devel@gnu.org; Sat, 20 May 2023 12:51:06 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q0PnM-0007e7-HU for emacs-devel@gnu.org; Sat, 20 May 2023 12:51:06 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 81C2B240103 for ; Sat, 20 May 2023 18:51:02 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1684601462; bh=rAX5PVIQlWcAvlJu6Rgzl7S2pmV1OpfDykWCRpd3+fI=; h=From:To:Cc:Subject:Autocrypt:Date:Message-ID:MIME-Version:From; b=a7QPigqLQPIt7A+5zez/K92CrVk41dYha/9DBQ284cu5YKnYHUblfYoLPoNk+n8Nr LlzRess7X/ENm1fsqDXlS449yF/Q43oS7zMijI21kh39G8P72Wid7DFQzMieTP0Cas IkpMneDVAmcxPYoA030sNe7RC9SvBC6VagEzMdcFMMMkNFbqprKV6OThh34cLspzMi wSDhIx96Cx0A4VBJvGlLc6GHQ8b3Ga/iQioLuE3UBkLqgjdLTS5X/NYcVv1bIY45gb aFKghhjC+hxeiBz96XVihoq/UkJnH34kBPshbFCkLd3hzhTO3sZAcaoJ4YB2vI5pfV wDKV/9N/qUZFw== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4QNqTx59MBz9rxH; Sat, 20 May 2023 18:51:01 +0200 (CEST) In-Reply-To: <87a5y1hreg.fsf@disroot.org> (Akib Azmain Turja's message of "Fri, 19 May 2023 10:33:11 +0600") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM Received-SPF: pass client-ip=185.67.36.66; envelope-from=philipk@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:306236 Archived-At: Akib Azmain Turja writes: > Jim Porter writes: > >> On 5/14/2023 12:33 PM, Philip Kaludercic wrote: >>> Jim Porter writes: >>> >>>> I think I need to adjust the passage a bit to emphasize that the >>>> Emacs/ELPA maintainers would *prefer* a simple and straightforward >>>> name like "gobject". ... >>> That would sound acceptable to me. >> >> Ok, how about something like the following? I just expanded it a bit >> to provide more context and adjusted the wording slightly here and >> there (for example, these are now "recommendations" instead of >> "guidelines"). >> >> ---------------------------------------- >> >> Naming is hard. However, taking some time to choose a good name for >> your package will help make your package easier to find and to use. To >> assist package authors, here are some recommendations for choosing >> good Emacs package names. Package names should be: >> >> * Memorable: Aim for short, distinct names that users can easily recall. >> * Intuitive: Names don't need to fully describe a package, but they >> should at least provide a hint about what the package does. >> >> For example, suppose I've written a package that provides an interface >> between GObjects and Emacs Lisp, and named it "goeli". This isn't a >> very good name, since it's not easy to remember (users may find >> themselves asking, "Wait... was it 'goli' or 'goeli'?"), and it's >> nearly impossible to guess what it does from the name. >> >> After thinking about it some more, I have a flash of insight: I'll >> call it "goblin" (for _GOb_ject _L_isp _In_terface)! This is easy >> enough to remember, but it's still not intuitive. >> >> Perhaps the best name for a package like this would simply be >> "gobject". That's both memorable *and* intuitive, not to mention being >> as straightforward as you can get. If possible, the ELPA maintainers >> recommend that you choose a name like this. >> >> However, suppose that at this point, I find myself disappointed: while >> "gobject" is a thoroughly practical name, I just don't want to give up >> the name "goblin". Instead, I could opt for a compromise: I'll still >> use "Goblin" when documenting the package and prefix names in my code >> with "goblin-", but I decide to submit it to GNU ELPA as >> "goblin-gobject". While this isn't as concise as "gobject", it does >> let the user know right away that this package has something to do >> with GObjects. >> > > The example name you suggested, "gobject", is indeed a good name, but > there's a little problem that if someone ever comes up with a better > package, it won't find any name for itself. One could argue this would help preventing NIH and encouraging people to contribute to existing projects.