Difference between revisions of "Reviewing Octave Forge packages"

From Octave
Jump to navigation Jump to search
(→‎Checklist: Review list)
(Update Checklist fill out procedure.)
Line 5: Line 5:
 
# Pick a package at https://sourceforge.net/p/octave/package-releases/
 
# Pick a package at https://sourceforge.net/p/octave/package-releases/
 
# Copy the check-list below and fill it out, marking each box:
 
# Copy the check-list below and fill it out, marking each box:
#* <code>[x]</code> for passed
+
#* <code>[x]</code> for successfully passed
#* <code>[n/a]</code> for non-applicable
+
#* <code>[ ]</code> for not done / error (please give below the checklist a brief reason)
#* <code>[ ]</code> for skipped (because you cannot do it, missing software, etc)
 
#* <code>[F]</code> for fails.
 
 
# Paste your filled in check-list as a comment on the issue above
 
# Paste your filled in check-list as a comment on the issue above
 
# An [https://sourceforge.net/p/octave/_members/ Octave Forge Admin] will try to look over your review and hopefully release the package.
 
# An [https://sourceforge.net/p/octave/_members/ Octave Forge Admin] will try to look over your review and hopefully release the package.

Revision as of 19:16, 30 September 2020

Info icon.svg
More than one person can review a package, in fact that would be great.

The reviewing procedure in short:

  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 successfully passed
    • [ ] for not done / error (please give below the checklist a brief reason)
  3. Paste your filled in check-list as a comment on the issue above
  4. An Octave Forge Admin will try to look over your review and hopefully release the package.

Checklist

# Repository

- [ ] maintainer has specified a corresponding revision commit/changeset
- [ ] checkout code from Sourceforge, commit/changeset is present

# Compile and Install

- [ ] release candidate installs on latest stable Octave release
- [ ] no compiler errors or warnings
- [ ] ran tests using <code>runtests /path/to/pkg</code> (use <code>oruntests</code> instead in Octave 6.0.0 or later)
- [ ] ran all tests, including those in src (how??)
- [ ] ran doctest on all functions (optional)
- [ ] ran generate_package_html (if Makefile present try <code> make html </code>)
- [ ] no makeinfo errors and warnings during HTML build
- [ ] unpacked and spot-checked the generated HTML documentation

# `pkg`-tool runs without errors or warnings

- [ ] `pkg load      foo`
- [ ] `pkg unload    foo`
- [ ] `pkg uninstall foo`
- [ ] Above steps were run on Octave and OS versions:
      -  ________
      -  ________

# Package files in release candidate tarball

- [ ] `DESCRIPTION` version updated
- [ ] `DESCRIPTION` minimum Octave tested
- [ ] `DESCRIPTION` all dependencies are listed
- [ ] `NEWS` version and date match
- [ ] `NEWS` big changes announced
- [ ] `INDEX` all (new) functions are listed
- [ ] version numbers in help text and function body (e.g., banners) updated
- [ ] license specifications in help text and function body agree `licensecheck -r`
- [ ] file permissions are readable/executable by all users
- [ ] junk files are removed (hidden dot files, backup files, results of configure runs, etc.)
- [ ] (optional if present) `src/configure.ac` version updated