[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
www/software maintainer-tips.html
|
From: |
Therese Godefroy |
|
Subject: |
www/software maintainer-tips.html |
|
Date: |
Mon, 27 Nov 2017 03:43:49 -0500 (EST) |
CVSROOT: /webcvs/www
Module name: www
Changes by: Therese Godefroy <th_g> 17/11/27 03:43:49
Modified files:
software : maintainer-tips.html
Log message:
Add 3 items: set up source code repo, upload to GNU FTP site,
and create home page (OK with RMS); cosmetic changes.
CVSWeb URLs:
http://web.cvs.savannah.gnu.org/viewcvs/www/software/maintainer-tips.html?cvsroot=www&r1=1.7&r2=1.8
Patches:
Index: maintainer-tips.html
===================================================================
RCS file: /webcvs/www/www/software/maintainer-tips.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- maintainer-tips.html 8 Nov 2014 00:27:52 -0000 1.7
+++ maintainer-tips.html 27 Nov 2017 08:43:48 -0000 1.8
@@ -2,6 +2,11 @@
<!-- Parent-Version: 1.77 -->
<title>Tips for new GNU maintainers
- GNU Project - Free Software Foundation</title>
+<style type="text/css" media="print,screen"><!--
+.all { color: red }
+.new { color: purple }
+.adopted { color: green }
+--></style>
<!--#include virtual="/software/po/maintainer-tips.translist" -->
<!--#include virtual="/server/banner.html" -->
@@ -21,57 +26,90 @@
have read them already, but they are densely enough written that careful
re-readings are useful. In addition, a few experienced GNU contributors
have volunteered to answer questions about GNU maintenance via
address@hidden as well as address@hidden</p>
+<address@hidden> as well as <address@hidden>.</p>
+
<h3>First steps for new maintainers</h3>
-<ul>
-<li><b>Update project information on Savannah.</b> Check under "Update
-Public Info" in the "Main" menu. Here, you should set the project's
+<p>These tasks are listed in order of priority. The labels
+(<span class="all">[All]</span>, <span class="new">[New]</span>, and
+<span class="adopted">[Adopted]</span>) indicate the category of packages
+each task mostly applies to.</p>
+
+<ol>
+<li><span class="all">[All]</span> <b>Update project information on
+ Savannah.</b> Go to your project page
+(<code>https://sv.gnu.org/projects/PKG</code>, where PKG is the name of your
+package), log in with your Savannah ID, and check under “Update public
+info” in the “Main” menu. Here, you should set the project's
full name and, if needed, write both a short and a long description for
-it (please also send those descriptions to address@hidden for use
+it (please also send those descriptions to <address@hidden> for use
in the lists of <a href="/software/software.html#allgnupkgs">all GNU
packages</a>). You should also set its development status to reflect
the maturity of the code. It is essential to do this if you have
-adopted a package, since it will be marked as "Orphan". (<a
-href="/prep/maintain/html_node/Old-Versions.html">About
-Savannah.</a>)</li>
-
-<li><b>Turn to the mailing lists.</b> If you have a new GNU
-package, you should set up at least one mailing list for the package via
-Savannah. It is strongly recommended to have one called
-<i>address@hidden</i>; others can wait until traffic warrants. If
+adopted a package, since it will be marked as “Orphan”.</li>
+
+<li><span class="all">[All]</span> <b>Turn to the mailing lists.</b> If you
+have a new GNU package, you should set up at least one mailing list for the
+package (“Select features” in the Main menu). It is strongly
+recommended to have one called <address@hidden>;
+others can wait until traffic warrants. If
you have adopted an existing package, send an email introducing
yourself. Finally, whether lists are newly created or already existing,
don't forget to subscribe yourself, as this is not automatically done.
(<a href="/prep/maintain/html_node/Mail.html">About dealing with
-mail.</a>)</li>
+mail</a>.)</li>
-<li><b>Check for existing bug reports.</b> If you have adopted an
-existing package, be sure to look for existing bug reports. These may
+<li><span class="new">[New]</span> <b>Set up a repository for your source
+code</b> (“Select features” in the Main menu), and import
+whatever is available (look up the procedures under “Source Code
+Manager” in the Development Tools section). Experience has shown
+that self-hosting is unreliable. (<a
+href="/prep/maintain/html_node/Old-Versions.html#Old-Versions">About back-up
+files</a>.)</li>
+
+<li><span class="new">[New]</span> <b>Upload your package to the GNU FTP
+site</b> if it is ready for public release. (<a
+href="/prep/maintain/html_node/Automated-FTP-Uploads.html">About the upload
+procedure</a>.)</li>
+
+<li><span class="new">[New]</span> <b>Create a GNU home page</b>, to replace
+the <code>PKG.html</code> file that webmasters have placed in your web repo
+(keep the same name). If you want to make this quick and easy, use our
+standard <a href="/server/standards/boilerplate.html">template</a>. Comment
+out the irrelevant parts, such as Downloading and Documentation if the
+project has barely started; you'll complete them later on. Also put any
+ documentation you already have in a subdirectory called
+“manual”. (<a
+href="/prep/maintain/html_node/Web-Pages.html">About web pages</a>.)</li>
+
+<li><span class="adopted">[Adopted]</span> <b>Check for existing bug
+reports</b> if you have adopted an existing package. These may
be on any or all of a Savannah bug tracker, a mailing list (mbox
archives are available via <a href="ftp://lists.gnu.org/";>ftp</a> and <a
href="rsync://lists.gnu.org/mbox/">rsync</a>), or at the <a
href="https://debbugs.gnu.org/";>GNU debbugs server</a>. (<a
href="/prep/maintain/html_node/Replying-to-Mail.html">About replying to
-bug reports.</a>)</li>
+bug reports</a>.)</li>
-<li><b>Contact distro packagers.</b> If you have adopted
+<li><span class="adopted">[Adopted]</span> <b>Contact distro packagers.</b>
+If you have adopted
an existing package and it is available in downstream distros, get in
contact with the packagers. It is likely that they have unresolved bug
reports to be addressed, and perhaps even patches that should be
applied. You may also like to get involved with the <a
href="/software/guix/guix.html">GNU Guix</a> package manager. (<a
-href="/distros/distros.html">About distros.</a>)</li>
+href="/distros/distros.html">About distros</a>.)</li>
-<li><b>Use the software.</b> It should go without saying that if you
+<li><span class="adopted">[Adopted]</span> <b>Use the software.</b>
+It should go without saying that if you
have adopted a GNU package, you should use it to get a feel for its
current status and to discover what might need to be fixed.</li>
-<li><b>Pick some tasks and start hacking!</b> There's no substitute for
-spending time doing the actual work.</li>
+<li><span class="all">[All]</span> <b>Pick some tasks and start hacking!</b>
+There's no substitute for spending time doing the actual work.</li>
+</ol>
-</ul>
<h3>General tips on maintaining GNU software</h3>
@@ -91,14 +129,14 @@
people know that an old package has been revived or that a new package
exists at all. (<a
href="/prep/maintain/html_node/Distributions.html">About making
-releases.</a>)</li>
+releases</a>.)</li>
-<li><b>Focus on fixing outstanding bugs first.</b> An excellent way to
-begin to learn a new codebase is to fix some outstanding bugs to get a
+<li><b>Focus on fixing outstanding bugs first.</b> This is an excellent
+way to start learning a new codebase, and get a
feel for how the system works. Besides, new features shouldn't be given
much focus if notable problems already exist. (<a
href="/software/devel.html">About resources for GNU
-developers.</a>)</li>
+developers</a>.)</li>
<li><b>Don't try to rewrite the entire thing.</b> If you've adopted
a package, we strongly recommend that you not set out to rewrite the
@@ -122,7 +160,7 @@
of software. If you have questions or run into problems, do not
hesitate to get in touch via address@hidden (<a
href="/prep/maintain/html_node/Recruiting-Developers.html">About
-recruiting developers.</a>)</li>
+recruiting developers</a>.)</li>
<li><b>Get involved.</b> GNU consists entirely of volunteers and
your participation in the organization is what you make of it! As a
@@ -131,7 +169,7 @@
contact and exposure to other like-minded volunteers. If you find an
aspect of GNU in which you would like to be involved, there is almost
certainly room for contribution. (<a href="/help/help.html">About
-helping GNU and free software.</a>)</li>
+helping GNU and free software</a>.)</li>
</ul>
@@ -226,7 +264,7 @@
<p class="unprintable">Updated:
<!-- timestamp start -->
-$Date: 2014/11/08 00:27:52 $
+$Date: 2017/11/27 08:43:48 $
<!-- timestamp end -->
</p>
</div>
- www/software maintainer-tips.html,
Therese Godefroy <=