From Fedora Project Wiki

(added links to guidelines)
Line 15: Line 15:
 
=== REQUIRED ITEMS ===
 
=== REQUIRED ITEMS ===
 
[ ]  Rpmlint output:
 
[ ]  Rpmlint output:
[ ]  Package is named according to the Package Naming Guidelines.
+
[ ]  Package is named according to the Package Naming Guidelines[1].
 
[ ]  Spec file name must match the base package name, in the format %{name}.spec.
 
[ ]  Spec file name must match the base package name, in the format %{name}.spec.
[ ]  Package meets the Packaging Guidelines.
+
[ ]  Package meets the Packaging Guidelines[2].
 
[ ]  Package successfully compiles and builds into binary rpms.
 
[ ]  Package successfully compiles and builds into binary rpms.
 
[ ]  Buildroot is correct (%{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n))
 
[ ]  Buildroot is correct (%{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n))
[ ]  Package is licensed with an open-source compatible license and meets other legal requirements as defined in the legal section of Packaging Guidelines.
+
[ ]  Package is licensed with an open-source compatible license and meets other legal requirements as defined in the legal section of Packaging Guidelines[3,4].
 
[ ]  License field in the package spec file matches the actual license.
 
[ ]  License field in the package spec file matches the actual license.
 
License type:
 
License type:
 
[ ]  If (and only if) the source package includes the text of the license(s) in its own file, then that file, containing the text of the license(s) for the package is included in %doc.
 
[ ]  If (and only if) the source package includes the text of the license(s) in its own file, then that file, containing the text of the license(s) for the package is included in %doc.
[ ]  All independent sub-packages have License of their own
+
[ ]  All independent sub-packages have license of their own
 
[ ]  Spec file is legible and written in American English.
 
[ ]  Spec file is legible and written in American English.
 
[ ]  Sources used to build the package matches the upstream source, as provided in the spec URL.
 
[ ]  Sources used to build the package matches the upstream source, as provided in the spec URL.
 
MD5SUM this package    :
 
MD5SUM this package    :
 
MD5SUM upstream package:
 
MD5SUM upstream package:
[ ]  All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines.
+
[ ]  All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines[5].
 
[ ]  Package must own all directories that it creates.
 
[ ]  Package must own all directories that it creates.
 
[ ]  Package requires other packages for directories it uses.
 
[ ]  Package requires other packages for directories it uses.
Line 78: Line 78:
 
*** REJECTED ***
 
*** REJECTED ***
 
================
 
================
 +
 +
[1] https://fedoraproject.org/wiki/Packaging:NamingGuidelines
 +
[2] https://fedoraproject.org/wiki/Packaging:Guidelines
 +
[3] https://fedoraproject.org/wiki/Packaging:LicensingGuidelines
 +
[4] https://fedoraproject.org/wiki/Licensing:Main
 +
[5] https://fedoraproject.org/wiki/Packaging/Guidelines#Exceptions_2
 
</pre>
 
</pre>

Revision as of 15:58, 21 September 2010

Java Review Template

Following template can be used by reviewers to simplify their reviews of Java packages and by packagers to double-check they haven't forgotten something.

Package Review
==============

Key:
- = N/A
x = Check
! = Problem
? = Not evaluated

=== REQUIRED ITEMS ===
[ ]  Rpmlint output:
[ ]  Package is named according to the Package Naming Guidelines[1].
[ ]  Spec file name must match the base package name, in the format %{name}.spec.
[ ]  Package meets the Packaging Guidelines[2].
[ ]  Package successfully compiles and builds into binary rpms.
[ ]  Buildroot is correct (%{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n))
[ ]  Package is licensed with an open-source compatible license and meets other legal requirements as defined in the legal section of Packaging Guidelines[3,4].
[ ]  License field in the package spec file matches the actual license.
License type:
[ ]  If (and only if) the source package includes the text of the license(s) in its own file, then that file, containing the text of the license(s) for the package is included in %doc.
[ ]  All independent sub-packages have license of their own
[ ]  Spec file is legible and written in American English.
[ ]  Sources used to build the package matches the upstream source, as provided in the spec URL.
MD5SUM this package    :
MD5SUM upstream package:
[ ]  All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines[5].
[ ]  Package must own all directories that it creates.
[ ]  Package requires other packages for directories it uses.
[ ]  Package does not contain duplicates in %files.
[ ]  Permissions on files are set properly.
[ ]  Package has a %clean section, which contains rm -rf %{buildroot} (or $RPM_BUILD_ROOT).
[ ]  Package consistently uses macros.
[ ]  Package contains code, or permissable content.
[ ]  Fully versioned dependency in subpackages, if present.
[ ]  Package contains a properly installed %{name}.desktop file if it is a GUI application.
[ ]  Package does not own files or directories owned by other packages.
[ ]  Javadoc documentation files are generated and included in -javadoc subpackage
[ ]  Javadoc subpackages have Require: jpackage-utils
[ ]  Packages using maven have proper BuildRequires/Requires(post) on jpackage-utils
[ ]  Packages using maven run %update_maven_depmap in %post/%postun
[ ]  Package uses %global not %define
[ ]  If package uses tarball from VCS include comment how to re-create that tarball (svn export URL, git clone URL, ...)
[ ]  If source tarball includes bundled jar/class files these need to be removed prior to building
[ ]  All filenames in rpm packages must be valid UTF-8.

=== SUGGESTED ITEMS ===
[ ]  If possible use upstream build method (maven/ant/javac)
[ ]  Use %{_mavenpomdir} macro for placing pom files instead of %{_datadir}/maven2/poms
[ ]  Javadocs are placed in %{_javadocdir}/%{name} with %{_javadocdir}/%{name}-%{version} symlink
[ ]  If package contains pom.xml files install it even when building with ant
[ ]  If package uses "-Dmaven.test.skip=true" explain why it was needed in a comment
[ ]  Avoid having BuildRequires on exact NVR unless necessary
[ ]  Package has BuildArch: noarch (if possible)
[ ]  Latest version is packaged.
[ ]  Reviewer should test that the package builds in mock.
Tested on:


=== Issues ===
1.

=== Final Notes ===
1.


================
*** APPROVED ***
================

or

================
*** REJECTED ***
================

[1] https://fedoraproject.org/wiki/Packaging:NamingGuidelines
[2] https://fedoraproject.org/wiki/Packaging:Guidelines
[3] https://fedoraproject.org/wiki/Packaging:LicensingGuidelines
[4] https://fedoraproject.org/wiki/Licensing:Main
[5] https://fedoraproject.org/wiki/Packaging/Guidelines#Exceptions_2