OrionPoplawski/ReviewChecklist

MUST:

- rpmlint reports: - The package is named according to the Package Naming Guidelines. - The spec file name matches the base package %{name}, in the format %{name}.spec - The package meets the Packaging Guidelines. - The package must be licensed with an open-source compatible license and meet other legal requirements as defined in the legal section of Packaging Guidelines. - The License field in the package spec file matches the actual license. - The license(s) for the package are included in %doc. - The spec file is written in American English. - The spec file for the package is legible. - The md5sum of the sources used to build the package match the upstream source. - The package successfully compiles and builds into binary rpms on at least one supported architecture. - MUST: If the package does not successfully compile, build or work on an architecture, then those architectures should be listed in the spec in ExcludeArch. Each architecture listed in ExcludeArch needs to have a bug filed in bugzilla, describing the reason that the package does not compile/build/work on that architecture. The bug number should then be placed in a comment, next to the corresponding ExcludeArch line. New packages will not have bugzilla entries during the review process, so they should put this description in the comment until the package is approved, then file the bugzilla entry, and replace the long explanation with the bug number. (Extras Only) The bug should be marked as blocking one (or more) of the following bugs to simplify tracking such issues: [WWW] FE-ExcludeArch-x86, [WWW]  FE-ExcludeArch-x64, [WWW]  FE-ExcludeArch-ppc - All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines. - The spec file handles locales properly. This is done by using the %find_lang macro. Using %{_datadir}/locale/* is strictly forbidden. - Every binary RPM package which stores shared library files (not just symlinks) in any of the dynamic linker's default paths, must call ldconfig in %post and %postun. If the package has multiple subpackages with libraries, each subpackage should also have a %post/%postun section that calls /sbin/ldconfig. An example of the correct syntax for this is:

%post -p /sbin/ldconfig

%postun -p /sbin/ldconfig



- 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. - 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. The exception to this are directories listed explicitly in the Filesystem Hierarchy Standard ([WWW] http://www.pathname.com/fhs/pub/fhs-2.3.html), as it is safe to assume that those directories exist. - MUST: A package must not contain any duplicate files in the %files listing. - MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example. Every %files section must include a %defattr(...) line. - MUST: Each package must have a %clean section, which contains rm -rf %{buildroot} (or $RPM_BUILD_ROOT). - MUST: Each package must consistently use macros, as described in the macros section of Packaging Guidelines. - MUST: The package must contain code, or permissable content. This is described in detail in the code vs. content section of Packaging Guidelines. - MUST: Large documentation files should 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) - 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. - MUST: Header files or static libraries must be in a -devel package. - MUST: Packages containing pkgconfig(.pc) files must 'Requires: pkgconfig' (for directory ownership and usability). - 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. - MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name} = %{version}-%{release} - MUST: Packages must NOT contain any .la libtool archives, these should be removed in the spec. - 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. This is described in detail in the desktop files section of Packaging Guidelines. 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. - 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 filesystem or man 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.

SHOULD Items:



- 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. - SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available. - SHOULD: The reviewer should test that the package builds in mock. - SHOULD: The package should compile and build into binary rpms on all supported architectures. - 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. - SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency. - 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.