[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa-admin df09582 201/439: * README: Add submission guideline
From: |
Philip Kaludercic |
Subject: |
[nongnu] elpa-admin df09582 201/439: * README: Add submission guideline |
Date: |
Sun, 17 Oct 2021 15:48:01 -0400 (EDT) |
branch: elpa-admin
commit df095824b50badd1a81467d488fdf844a37c3ff7
Author: Artur Malabarba <bruce.connor.am@gmail.com>
Commit: Artur Malabarba <bruce.connor.am@gmail.com>
* README: Add submission guideline
---
README | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++------
1 file changed, 50 insertions(+), 6 deletions(-)
diff --git a/README b/README
index fe5a4f1..ed74125 100644
--- a/README
+++ b/README
@@ -34,7 +34,48 @@ 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)
+
+Adding a basic package is very simple. There are thorough
+instructional, but the gist is that you:
+
+1. Notify emacs-devel@gnu.org.
+2. Place all files inside `packages/<pkg-name>/'.
+3. `git add', `git commit' and `git push'.
+
+If you don't have push access to the repository, someone will do steps
+2 and 3 for you.
+
+*** 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.
+
+Before doing anything, please ensure your package follows the
+conventions described in the `** Format' section. Then, 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, but you can write more or less than that if you'd like.
+
+At the bottom of the message contents include the changes you're going
+to make (the patch). For a single-file package this can be the
+package file itself instead of the patch. If you prefer (and if you
+have push access), you can push your changes to a branch called
+`scratch/<pkg-name>', and mention the branch in your message.
+
+After 48h, or once any issues have been addressed, someone will push
+your changes for you. 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.
@@ -88,12 +129,15 @@ and the web-pages from this source code:
** External branches
-The easiest way to maintain and develop GNU Elpa packages is to just
-edit them right here (in elpa.git). However, some maintainers may
-prefer to use a dedicated repository or branch for the package. There
-are two ways to do that: subtrees and externals.
+The above instructions are enough to add regular packages, those that
+are maintained primarily here in the repository. The instructions
+below are for those maintainers who prefer to use a dedicated
+repository or branch for the package.
+
+There are two ways to do that: subtrees and externals.
-Such packages should be listed in the `externals-list' file.
+Either way, such packages should always be listed in the
+`externals-list' file.
In both cases, a copy of the code is kept in the `elpa' repository
(not necessarily in the master branch) and should be sync'd with the
- [nongnu] elpa-admin 4d58120 179/439: * GNUmakefile: Fix autoloads generation for aggressive-indent, (continued)
- [nongnu] elpa-admin 4d58120 179/439: * GNUmakefile: Fix autoloads generation for aggressive-indent, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin aec5d97 172/439: Merge branch 'master' of git.sv.gnu.org:/srv/git/emacs/elpa, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 28819e8 192/439: Skip uninteresting elements, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin cb8a04b 195/439: * admin/archive-contents.el: Improve docstrings, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin ac1e1e9 198/439: README: Fix typos., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin f936e1e 180/439: Merge dummy commit to add the gnorb subtree metadata., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 3a394c3 188/439: Merge commit 'd76bcd7c0dcecb33e6955e25963028600c371588', Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 5e9fdd4 197/439: * README: Revert change about package.el headers, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 9731033 204/439: Use symbolic links for core packages, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 7edd6ff 205/439: Dereference symlinks when creating tarballs, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin df09582 201/439: * README: Add submission guideline,
Philip Kaludercic <=
- [nongnu] elpa-admin 7fa1dbd 214/439: Merge branch 'master' of git.sv.gnu.org:/srv/git/emacs/elpa, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 5571ea8 211/439: Add symlink to README, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 60ab286 213/439: Squashed 'packages/gnome-c-style/' content from commit e84487c, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 9ab6e7e 217/439: Update packages/yasnippet by subtree-merging from its external upstream, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin f1c2e2f 210/439: Merge branch 'master' of git.sv.gnu.org:/srv/git/emacs/elpa: transcribe.el update, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin cc33931 222/439: Add test capability to ELPA, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 968d870 212/439: Merge commit 'cce1d8b50b1ceccb80c20398cd659db3a6348aac' as 'packages/gnome-c-style', Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 2ba4dc8 215/439: Merge commit '6bf96861b98e91ca9c3bd146697580b42d30f5d9', Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin f79a619 218/439: * packages/gnome-c-style/gnome-c-tests.el: Add copyright blurb, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 73a80fc 227/439: Update packages/yasnippet by subtree-merging from its github-based upstream, Philip Kaludercic, 2021/10/17