Reviewing Octave Forge packages: Difference between revisions

From Octave
Jump to navigation Jump to search
(→‎Help reviewing Octave-Forge packages: add a "what next" section)
Tags: Mobile edit Mobile web edit
(→‎Checklist: added dep)
Tags: Mobile edit Mobile web edit
Line 27: Line 27:


[ ] package works on minimum Octave version in DESCRIPTION
[ ] package works on minimum Octave version in DESCRIPTION
[ ] Run generate_package_html
[ ] reasonable dependencies listed in DESCRIPTION
[ ] ran generate_package_html
[ ] no makeinfo errors and warnings during HTML build
[ ] no makeinfo errors and warnings during HTML build
[ ] unpacked and spot-checked the generated HTML documentation
[ ] unpacked and spot-checked the generated HTML documentation

Revision as of 01:51, 15 March 2019

Help reviewing Octave-Forge packages

We need help. Here is how:

  1. Pick a package at https://sourceforge.net/p/octave/package-releases/
  2. Copy the check-list below and fill it out, marking each box:
    * `[x]` for passed
    * `[n/a]` for non-applicable
    * `[S]` for skipped (because you cannot do it, missing software, etc)
    * `[F]` for fails.
  1. Paste your filled in check-list as a comment on the issue above

What happens next

An admin will try to look over your review and hopefully release the package. More than one person can review a package, in fact that would be great.


Checklist

[ ] release candidate installed on latest Octave release
[ ] no compiler errors or serious warnings
[ ] ran all tests using runtests (including tests in the src dir)
[ ] ran doctest on all functions (optional)
[ ] Above steps were run on Octave versions:
     *  ________ [provide list]

[ ] package works on minimum Octave version in DESCRIPTION
[ ] reasonable dependencies listed in DESCRIPTION
[ ] ran generate_package_html
[ ] no makeinfo errors and warnings during HTML build
[ ] unpacked and spot-checked the generated HTML documentation
[ ] NEWS file makes sense, version and date match
[ ] All functions are listed in INDEX

Common problems

Here are some common problems that reviewers can check for

  • INDEX is missing some new functions added
  • NEWS has not been updated or is missing something big
  • Version numbers or dates do not match between DESCRIPTION and NEWS
  • Common makeinfo errors like "@bye seen before @end deftypefn"
  • DESCRIPTION says pkg works with old Octave 4.x but it fails for me
  • Obviously, compiler errors, warnings, test failures