unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* [ELPA] Proposed (small) rules change
@ 2015-10-14 12:59 Artur Malabarba
  0 siblings, 0 replies; only message in thread
From: Artur Malabarba @ 2015-10-14 12:59 UTC (permalink / raw)
  To: emacs-devel

I'd like to make the following change to Elpa's Readme.
It asks that people send an email to emacs-devel before adding any
package (which is something that most already do anyway, though I'm
guilty of the contrary).

This is not intended to scare away new contributors. It is actually
intended to make them feel safer that someone is actually checking
what they're about to do.

Cheers,
Artur Malabarba

---

* README: Add submission guideline

1 file changed, 30 insertions(+), 1 deletion(-)
README | 31 ++++++++++++++++++++++++++++++-

modified   README
@@ -34,7 +34,36 @@ safely work on the next version here without
worrying about the unstable
 code making it to GNU ELPA, and simply update the "version" when you want to
 release the new code.

-** To add a package:
+** To add a package: (submission, submit)
+
+*** Notify emacs-devel@gnu.org
+
+There is no approval process for GNU Elpa packages.  Still,
+you must send an email to emacs-devel for several reasons:
+
+- Notifying other developers;
+- Making sure the package doesn't break FSF rules;
+- Checking if the package is not reinventing the wheel;
+- Ensuring that first-time developers are doing it right.
+
+Send an email to the list with the subject:
+    [ELPA] New package: <pkg-name>
+
+Start your message with an explanation about the package.  A
+copy-paste of the package's Summary and Commentary is perfectly fine
+here.
+
+At the bottom of the message contents include the changes you're going
+to make (the patch).  For a single-file package this can also be the
+package file itself.  If you prefer, you can push your changes to a
+branch called `scratch/<pkg-name>', and mention the branch in your
+message.
+
+After 48h, if nobody points out any issues, feel free to push your
+commits.  You should probably also subscribe to emacs-devel@gnu.org,
+since that's where we discuss about GNU Elpa, and to
+bug-gnu-emacs@gnu.org, since that's where people will report bugs
+about your package.

 *** Add a simple (1-file) package as packages/<pkg-name>/<pkg-name>.el.



^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2015-10-14 12:59 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-10-14 12:59 [ELPA] Proposed (small) rules change Artur Malabarba

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).