User:Jlaska/Package Review Checklist

From FedoraProject

Jump to: navigation, search

MUST requirements

[      ] MUST: rpmlint must be run on the source rpm and all binary rpms the
         build produces. The output should be posted in the review.(refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#rpmlint)
[      ] MUST: The package must be named according to the
         http://fedoraproject.org/wiki/Packaging/NamingGuidelines
[      ] MUST: The spec file name must match the base package
         <code>%{name}</code>, in the format <code>%{name}.spec</code> unless your
         package has an exemption. (refer to
         http://fedoraproject.org/wiki/Packaging/NamingGuidelines#Spec_file_name).
[      ] MUST: The package must meet the
         http://fedoraproject.org/wiki/Packaging/Guidelines.
[      ] MUST: The package must be licensed with a Fedora approved license and
         meet the http://fedoraproject.org/wiki/Packaging/LicensingGuidelines.
[      ] MUST: The License field in the package spec file must match the actual
         license. (refer to
         http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#ValidLicenseShortNames)
[      ] MUST: 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 must be included in <code>%doc</code>.(refer to
         http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License Text)
[      ] MUST: The spec file must be written in American English. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#summary)
[      ] MUST: The spec file for the package '''MUST''' be legible. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Spec_Legibility)
[      ] MUST: The sources used to build the package must match the upstream
         source, as provided in the spec URL. Reviewers should use md5sum for this task.
         If no upstream URL can be specified for this package, please see the
         http://fedoraproject.org/wiki/Packaging/SourceURL for how to deal with
         this.
[      ] MUST: The package '''MUST''' successfully compile and build into
         binary rpms on at least one primary architecture. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Architecture_Support)
[      ] MUST: If the package does not successfully compile, build or work on
         an architecture, then those architectures should be listed in the spec in
         <code>ExcludeArch</code>. Each architecture listed in <code>ExcludeArch</code>
         '''MUST''' have a bug filed in bugzilla, describing the reason that the package
         does not compile/build/work on that architecture. The bug number '''MUST''' be
         placed in a comment, next to the corresponding <code>ExcludeArch</code> line.
         (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Architecture_Build_Failures)
[      ] MUST: All build dependencies must be listed in
         <code>BuildRequires</code>, except for any that are listed in the
         http://fedoraproject.org/wiki/Packaging/Guidelines#Exceptions_2 section of the
         Packaging Guidelines ; inclusion of those as <code>BuildRequires</code> is
         optional. Apply common sense.
[      ] MUST: The spec file MUST handle locales properly. This is done by
         using the <code>%find_lang</code> macro. Using
         <code>%{_datadir}/locale/*</code> is strictly forbidden.(refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Handling_Locale_Files)
[      ] MUST: Every binary RPM package (or subpackage) which stores shared
         library files (not just symlinks) in any of the dynamic linker's default paths,
         must call ldconfig in <code>%post</code> and <code>%postun</code>. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Shared_Libraries)
[      ] MUST: Packages must NOT bundle copies of system libraries.(refer to
         http://fedoraproject.org/wiki/Packaging:Guidelines#Duplication_of_system_libraries)
[      ] MUST: If the package is designed to be relocatable, the packager must
         state this fact in the request for review, along with the rationalization for
         relocation of that specific package. Without this, use of Prefix: /usr is
         considered a blocker. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#RelocatablePackages)
[      ] MUST: A package must own all directories that it creates. If it does
         not create a directory that it uses, then it should require a package which
         does create that directory.  (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#FileAndDirectoryOwnership)
[      ] MUST: A Fedora package must not list a file more than once in the spec
         file's %files listings. (Notable exception: license texts in specific
         situations)(refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#DuplicateFiles)
[      ] MUST: Permissions on files must be set properly. Executables should be
         set with executable permissions, for example. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#FilePermissions)
[      ] MUST: Each package must consistently use macros. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#macros)
[      ] MUST: The package must contain code, or permissable content. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#CodeVsContent)
[      ] MUST: Large documentation files must go in a -doc subpackage. (The
         definition of large is left up to the packager's best judgement, but is not
         restricted to size. Large can refer to either size or quantity). (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation)
[      ] MUST: If a package includes something as %doc, it must not affect the
         runtime of the application. To summarize: If it is in %doc, the program must
         run properly if it is not present. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation)
[      ] MUST: Header files must be in a -devel package. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#DevelPackages)
[      ] MUST: Static libraries must be in a -static package. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#StaticLibraries)
[      ] MUST: If a package contains library files with a suffix (e.g.
         libfoo.so.1.1), then library files that end in .so (without suffix) must go in
         a -devel package. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#DevelPackages)
[      ] MUST: In the vast majority of cases, devel packages must require the
         base package using a fully versioned dependency: <code>Requires:
         %{name}%{?_isa} = %{version}-%{release} </code> (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#RequiringBasePackage)
[      ] MUST: Packages must NOT contain any .la libtool archives, these must
         be removed in the spec if they are built.(refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#StaticLibraries)
[      ] MUST: Packages containing GUI applications must include a
         %{name}.desktop file, and that file must be properly installed with
         desktop-file-install in the %install section. If you feel that your packaged
         GUI application does not need a .desktop file, you must put a comment in the
         spec file with your explanation. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#desktop)
[      ] MUST: Packages must not own files or directories already owned by
         other packages. The rule of thumb here is that the first package to be
         installed should own the files or directories that other packages may rely
         upon. This means, for example, that no package in Fedora should ever share
         ownership with any of the files or directories owned by the
         <code>filesystem</code> or <code>man</code> package. If you feel that you have
         a good reason to own a file or directory that another package owns, then please
         present that at package review time. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#FileAndDirectoryOwnership)
[      ] MUST: All filenames in rpm packages must be valid UTF-8. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#FilenameEncoding)

SHOULD requirements

[      ] SHOULD: If the source package does not include license text(s) as a
         separate file from upstream, the packager SHOULD query upstream to include it.
         (refer to
         http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License_Text)
[      ] SHOULD: The description and summary sections in the package spec file
         should contain translations for supported Non-English languages, if available.
         (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#summary)
[      ] SHOULD: The reviewer should test that the package builds in mock.
         (refer to http://fedoraproject.org/wiki/PackageMaintainers/MockTricks)
[      ] SHOULD: The package should compile and build into binary rpms on all
         supported architectures. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#ArchitectureSupport)
[      ] SHOULD: The reviewer should test that the package functions as
         described. A package should not segfault instead of running, for example.
[      ] SHOULD: If scriptlets are used, those scriptlets must be sane. This is
         vague, and left up to the reviewers judgement to determine sanity. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Scriptlets)
[      ] SHOULD: Usually, subpackages other than devel should require the base
         package using a fully versioned dependency. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#RequiringBasePackage)
[      ] SHOULD: The placement of pkgconfig(.pc) files depends on their
         usecase, and this is usually for development purposes, so should be placed in a
         -devel pkg.  A reasonable exception is that the main pkg itself is a devel tool
         not installed in a user runtime, e.g. gcc or gdb. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#PkgconfigFiles)
[      ] SHOULD: If the package has file dependencies outside of /etc, /bin,
         /sbin, /usr/bin, or /usr/sbin consider requiring the package which provides the
         file instead of the file itself. (refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#FileDeps)
[      ] SHOULD: your package should contain man pages for binaries/scripts. If
         it doesn't, work with upstream to add them where they make sense.(refer to
         http://fedoraproject.org/wiki/Packaging/Guidelines#Man_pages)