Reviewing Octave Forge packages: Difference between revisions

Reviewing Octave Forge packages (edit)

Revision as of 03:25, 1 October 2020

360 bytes removed , 1 October 2020

→‎Checklist: Review list

Siko1056

Bureaucrats, Administrators

1,852

edits

@@ Line 13: / Line 13: @@
 <pre>
-# Repository
+# Repository / Metadata
-- [ ] maintainer has specified a corresponding revision commit/changeset
+- [ ] release commit/changeset specified and present in repository
-- [ ] checkout code from Sourceforge, commit/changeset is present
+- [ ] `generate_package_html` / `make html` works without errors and warnings
+- [ ] generated HTML documentation looks sane
-# Compile and Install
+# pkg-tool runs without errors or warnings
-- [ ] 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 install   foo`
 - [ ] `pkg load      foo`
 - [ ] `pkg unload    foo`
 - [ ] `pkg uninstall foo`
-- [ ] Above steps were run on Octave and OS versions:
+- Above steps were run on Octave and OS versions:
-      -  ________
+  -  ________
-      -  ________
+  -  ________
+# Package tests
+- [ ] ran tests (`runtests /path/to/pkg` or `oruntests`)
+- [ ] ran `doctest` on all functions
 # Package files in release candidate tarball