[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] new-master 4041990 081/128: * README: Add submission guideline
From: |
Stefan Monnier |
Subject: |
[elpa] new-master 4041990 081/128: * README: Add submission guideline |
Date: |
Mon, 14 Dec 2020 15:39:36 -0500 (EST) |
branch: new-master
commit 40419901bcf508523d69bf7567083fd33f2fe4fb
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
- [elpa] new-master 9192ab3 037/128: Continue previous change., (continued)
- [elpa] new-master 9192ab3 037/128: Continue previous change., Stefan Monnier, 2020/12/14
- [elpa] new-master 3f7d70e 041/128: update README, Stefan Monnier, 2020/12/14
- [elpa] new-master 7765674 042/128: Minor fix, according to the GNU Web Site Guidelines, Stefan Monnier, 2020/12/14
- [elpa] new-master 7f9bb59 063/128: Remove version.texi from the repo, Stefan Monnier, 2020/12/14
- [elpa] new-master 05fc9f6 062/128: Add packages/darkroom by merging its upstream subtree, Stefan Monnier, 2020/12/14
- [elpa] new-master 0c3c141 061/128: Merge commit '469cd3bc117bfb8da0c03a2a2fb185e80c81d068', Stefan Monnier, 2020/12/14
- [elpa] new-master 14a3028 075/128: * README: Expand instructions, Stefan Monnier, 2020/12/14
- [elpa] new-master 62cd08c 069/128: Add 'packages/realgud/' from commit 'd811316e6a0f4eeee8a1347f504c196c86baa2cb', Stefan Monnier, 2020/12/14
- [elpa] new-master 9a3d3a1 086/128: Merge branch 'master' into new-website, Stefan Monnier, 2020/12/14
- [elpa] new-master c1a9997 085/128: Merge commit '1054ea1bc5b07a1438a18c1b33f4266b28ff9d77', Stefan Monnier, 2020/12/14
- [elpa] new-master 4041990 081/128: * README: Add submission guideline,
Stefan Monnier <=
- [elpa] new-master b586c0e 076/128: * README: Revert change about package.el headers, Stefan Monnier, 2020/12/14
- [elpa] new-master 6a044b5 091/128: Merge branch 'master' into new-website, Stefan Monnier, 2020/12/14
- [elpa] new-master 2e8f5ad 089/128: Updated v1.05 for Savannah and GNU ELPA, Stefan Monnier, 2020/12/14
- [elpa] new-master bf0be51 092/128: Website footer improvement, Stefan Monnier, 2020/12/14
- [elpa] new-master 82fbc4f 096/128: Added copyright and licensing information to all files, Stefan Monnier, 2020/12/14
- [elpa] new-master 55116c1 099/128: Add explicit instructions for new external packages, Stefan Monnier, 2020/12/14
- [elpa] new-master e8a6d9d 103/128: * README: Clarify the right fix for check_copyrights failure, Stefan Monnier, 2020/12/14
- [elpa] new-master 80420ec 105/128: * README: Don't clone a clone., Stefan Monnier, 2020/12/14
- [elpa] new-master c778396 108/128: * README: Recommend "externals" and add some recommendations, Stefan Monnier, 2020/12/14
- [elpa] new-master c1d5f54 101/128: Add 'packages/paced/' from commit '223809ea68c8d86aef2b61a946d61497125ba250', Stefan Monnier, 2020/12/14