[Savannah-cvs] [538] add links, improve wordings, reformat

[ineiev]

Revision: 538
          
http://svn.savannah.gnu.org/viewvc/?view=rev&root=administration&revision=538
Author:   ineiev
Date:     2023-02-03 13:28:09 -0500 (Fri, 03 Feb 2023)
Log Message:
-----------
add links, improve wordings, reformat

Modified Paths:
--------------
    trunk/sviki/HowToGetYourProjectApprovedQuickly.mdwn

Modified: trunk/sviki/HowToGetYourProjectApprovedQuickly.mdwn
===================================================================
--- trunk/sviki/HowToGetYourProjectApprovedQuickly.mdwn 2023-02-03 18:25:48 UTC 
(rev 537)
+++ trunk/sviki/HowToGetYourProjectApprovedQuickly.mdwn 2023-02-03 18:28:09 UTC 
(rev 538)
@@ -1,5 +1,4 @@
-Advice on Submitting Projects to Savannah
-=========================================
+# Advice on submitting projects to Savannah
 
 Project evaluation and approval (or rejection) is subject to
 Savannah's
@@ -11,10 +10,8 @@
 savannah-hackers-public@gnu.org (or savannah-hackers-private@gnu.org
 for private matters). Escalate to gnu-advisory@gnu.org if needed.
 
+## Evaluation guidelines
 
-Evaluation Guidelines
----------------------
-
 This is not the
 [official hosting policy](//savannah.gnu.org/register/requirements.php);
 just advice.
@@ -25,32 +22,33 @@
 
 -   Make sure your project runs primarily on a completely free OS.
 
--   Regarding Android phones: Provided Savannah's maintainers have the
+-   Regarding Android: provided Savannah's maintainers have the
     capacity, projects running on Replicant may be hosted on Savannah.
-    Projects having dependencies on non-free software, such as
+    Projects having dependencies on nonfree software, such as
     proprietary software drivers or AndroidOS, are not permissible.
 
 -   Use a license compatible with the GNU GPL, and use the "or any later
     version" formulation in your license notices. Implication: the
-    license must be compatible with GNU GPLv3-or-later. (This license is
-    preferred for the GNU Project.)
+    license must be compatible with GNU GPLv3 and any later version.
+    (This license is preferred for the GNU Project.)
 
 -   Write a short technical description of your project: its goal, its
-    programming language and its dependencies (with URLs).
+    programming language and its [[dependencies|URIsToTheDependencies]].
 
 -   Give a pointer to your source code, or upload it as an attachment to
     the submission.
 
--   Apply valid copyright and license notices ([[ValidNotices]]) using
-    our templates to each source file in your project; include a copy of
-    the license you chose.  It is ideal for derived files to carry
+-   Apply [[valid copyright and license notices|ValidNotices]]
+    to each source file in your project; include a copy of
+    every license you use.  It is ideal for derived files to carry
     (generated) notices as well.  See the
     [GPL HowTo](//www.gnu.org/licenses/gpl-howto.html).
 
--   Refer to the "GNU/Linux operating system" instead of "Linux", which
-    is the kernel. Advertise the free software movement, which we
-    support, and not open source, which we don't. Do not use "Open" in
-    your project name.
+-   Refer to the
+    [GNU/Linux operating system](//www.gnu.org/gnu/why-gnu-linux.html)
+    instead of "Linux", which is the kernel.  Advertise the free software
+    movement, which we support, and not open source, which we don't.
+    Do not use "Open" in your project name.
 
 -   Do not use "GNU" in your project name unless it has been officially
     dubbed a GNU package. See
@@ -58,10 +56,10 @@
     for information about that process; it does not happen through
     Savannah.
 
--   Project identifiers should be at least four characters long (barring
+-   Unix group names should be at least four characters long (barring
     historical practice or some other exceptional case), and
     as specific and descriptive as possible.  Your project will be part
-    of a huge universe of free software both on and off of Savannah.
+    of a huge universe of free software both on and off Savannah.
     Strive for a globally unique name that makes it easy to find.
 
 The review we do can be lengthy and difficult for both the submitter and
@@ -72,91 +70,107 @@
 awareness of these legal and philosophical issues related to free
 software.
 
-Here are further details:
+## Further details
 
--   Runs primarily on a free operating system. Proprietary platforms
-    such as Microsoft Windows should be considered as secondary
-    targets, and cannot provide additional features over the ports
-    to free OSes.
+### Develop for free OSes
 
--   Project dependencies: to make the approval process quicker, give us
-    URLs to your dependencies, ideally with direct links to their
-    licenses.
+Proprietary platforms such as Microsoft Windows should be considered
+as secondary targets, and cannot provide additional features over
+the ports to free OSes.
 
--   GNU GPL-compatible license: your license should be listed as
-    compatible in [GNU License List](//www.gnu.org/licenses/license-list.html).
-    You can also use the GNU Affero GPL, since it is effectively compatible
-    with GPLv3. For documentation, we accept the GNU Free Documentation
-    License (and compatible), even though is not compatible with the GNU
-    GPL. Always use the "or any later version" wording in your notices,
-    as otherwise future compatibility problems are crated. (Aside: for
-    the LGPL, we can technically accept LGPLv2-only since it can be
-    converted to any version of the GPL, but we nevertheless strongly
-    recommend against using LGPL\*-only. More aside: as of 2019,
-    we consider LGPLv3-or-later compatible with GPLv3 and any later
-    versions of the GPL, even though LGPLv3 has no LGPLv2-like provisions,
-    and further versions of the LGPL have not been drafted yet.)
-    For more info, see [[LicensingRequirements]].
+### Project dependencies
 
--   Consistent licensing:
-    Write appropriate copyright and license notices ([[ValidNotices]]),
-    at the beginning of _all_ of your source (non-derivative) files.
-    Standard templates are in the
-    [GPL HowTo](//www.gnu.org/licenses/gpl-howto.html) and
-    [Information for maintainers of GNU
-    software](//www.gnu.org/prep/maintain/html_node/Copyright-Notices.html);
-    please use them to speed up approval.  More answers in the
-    [GPL FAQ](//www.gnu.org/licenses/gpl-faq.html).  For the GFDL, check the
-    [FDL HowTo](//www.gnu.org/licenses/fdl-howto.html).
+To make the approval process quicker, give us URLs to your
+dependencies, ideally with direct links to their website pages
+explaining their licensing.
 
--   Source files include Makefiles, scripts, and ChangeLogs from
-    your project, not just bare source code.
+### GNU GPL-compatible license
 
--   Include a verbatim copy of the license in your project as plain
-    text, do not point users to an external source to get the license.
+Your license should be listed as compatible in [GNU License
+List](//www.gnu.org/licenses/license-list.html).  You can also use
+the GNU Affero GPL, since it is effectively compatible with GPLv3.
+For documentation, we accept the GNU Free Documentation License (and
+compatible), even though is not compatible with the GNU GPL. Always
+use the "or any later version" wording in your notices, as otherwise
+future compatibility problems are created. (Aside: for the LGPL, we
+can technically accept LGPLv2-only since it can be converted to any
+version of the GPL, but we nevertheless strongly recommend against
+using LGPL\*-only. More aside: as of 2019, we consider
+LGPLv3-or-later compatible with GPLv3 and any later versions of the
+GPL, even though LGPLv3 has no LGPLv2-like provisions, and further
+versions of the LGPL have not been drafted yet.) For more info, see
+[[licensing requirements|LicensingRequirements]].
 
--   Do not combine code with incompatible licenses (e.g., GNU GPL'd
-    code with CPL'd code). The GPL Compliance Lab,
-    <mailto:licensing@fsf.org>, may provide advice
-    for complex cases. For Perl code, avoid the modules released under
-    the Artistic license only; for PHP, avoid modules released under
-    the PHP license. If you want to use such modules, please ask their
-    authors to use licenses compatible with the GNU GPL.
+### Consistent licensing
 
--   No proprietary dependencies: your project
-    must work on a completely free operating system. Find free
-    replacements for your non-free dependencies. Develop and test your
-    Java applications with [[IcedTea]] ([[OpenJDK]]), and your .Net ones
-    with DotGNU (or other free alternatives). See [[JavaIssues]].
+Write [[appropriate copyright and license notices|ValidNotices]], at
+the beginning of _all_ of your source (non-derivative) files.
+Standard templates are in the [GPL
+HowTo](//www.gnu.org/licenses/gpl-howto.html) and [Information for
+maintainers of GNU
+software](//www.gnu.org/prep/maintain/html_node/Copyright-Notices.html);
+please use them to speed up approval.  More answers in the [GPL
+FAQ](//www.gnu.org/licenses/gpl-faq.html).  For the GFDL, check the
+[FDL HowTo](//www.gnu.org/licenses/fdl-howto.html).
 
--   No storage or back-up-only project: we exist to help people
-    develop software and technical documentation. Other hosting
-    services offer storage space. We expect to be used primarily and
-    not as a back-up, although we do not require all parts of the
-    project to be hosted at Savannah.
+Source files include Makefiles, scripts, image files, and ChangeLogs
+from your package, not just bare source code.
 
--   We discourage submitting simplistic text-only projects, such as a
-    single text or html file containing a list of urls.  Such things are
-    better maintained as straightforward web pages than incurring all
-    the overhead of a full project at Savannah.  Nonetheless, if you
-    think your file is special and deserves its own dedicated project,
-    we will consider your argument.
+Include a verbatim copy of all licenses used in your package as plain
+text, do not point users to an external source to get the license.
 
--   Tell people that they are using the GNU/Linux variant of the GNU
-    operating system, and that Linux is its kernel, not the whole OS.
-    See [Linux and GNU](//www.gnu.org/gnu/linux-and-gnu.html) and
-    the [GNU/Linux FAQ](//www.gnu.org/gnu/gnu-linux-faq.html).
+Do not combine code with incompatible licenses (e.g., GNU GPL'd
+code with CPL'd code). The GPL Compliance Lab,
+<mailto:licensing@fsf.org>, may provide advice
+for complex cases. For Perl code, avoid the modules released under
+the Artistic license only; for PHP, avoid modules released under
+the PHP license. If you want to use such modules, please ask their
+authors to use licenses compatible with the GNU GPL.
 
--   We support the free software movement, as opposed to "open
-    source", because we feel strongly about ethics.  That is, our
-    primary focus is the freedom offered to users of free
-    software. Further information in
-    [Why Open Source Misses the Point of Free
-    Software](//www.gnu.org/philosophy/open-source-misses-the-point.html).
-    As a consequence, we do not accept projects with the word "open" in
-    their name; we suggest you replace it with "free" instead, or use
-    another project name of your choice.
+### No proprietary dependencies
 
+Your software must work on a completely free operating system. Find
+free replacements for your nonfree dependencies. Develop and test
+your Java applications with IcedTea (OpenJDK), and your .Net
+ones with DotGNU (or other free implementations).
+See [[Java issues|JavaIssues]].
+
+### No storage or back-up-only group
+
+We exist to help people develop software and technical
+documentation. Other hosting services offer storage space. We expect
+to be used primarily and not as a back-up, although we do not
+require all parts of the project to be hosted at Savannah.
+
+### No simplistic packages
+
+We discourage submitting simplistic text-only projects, such as a
+single text or html file containing a list of URLs.  Such things are
+better maintained as straightforward web pages than incurring all
+the overhead of a full group at Savannah.  Nonetheless, if you
+think your file is special and deserves its own dedicated group,
+we will consider your argument.
+
+### Say GNU/Linux
+
+Tell people that they are using the GNU/Linux variant of the GNU
+operating system, and that Linux is its kernel, not the whole OS.
+See [Linux and GNU](//www.gnu.org/gnu/linux-and-gnu.html) and the
+[GNU/Linux FAQ](//www.gnu.org/gnu/gnu-linux-faq.html).
+
+### Support freedom
+
+We support the free software movement, as opposed to "open
+source", because we feel strongly about ethics.  That is, our
+primary focus is the freedom offered to users of free software.
+Further information in [Why Open Source Misses the Point of Free
+Software](//www.gnu.org/philosophy/open-source-misses-the-point.html).
+As a consequence, we do not accept projects with the word "open" in
+their name; we suggest you replace it with "free" instead, or use
+another project name of your choice.
+
+## Conclusion
+
 If you follow all this advice and carefully prepare your project
 accordingly, your project is more likely to be reviewed quickly, and
 more likely to be approved after the first review.