diff --git a/README.org b/README.org index 6bfe925..5c2d994 100644 --- a/README.org +++ b/README.org @@ -8,10 +8,8 @@ /melpazoid/ is a bundle of scripts for testing Emacs packages, primarily submissions to [[https://github.com/melpa/][MELPA]]. I've been using this to help check MELPA [[https://github.com/melpa/melpa/pulls][pull requests]]. The ambition is checks that run in a "clean" environment, either through CI or -through a container on your local machine. - -This is a work in progress -- feedback and pull requests are welcome ([[https://github.com/riscy/melpazoid/search?q=TODO&unscoped_q=TODO][search for -TODO]]s, [[https://github.com/riscy/melpazoid/issues][raise an issue]], whatever). +through a container on your local machine. Feedback and pull requests are +welcome ([[https://github.com/riscy/melpazoid/search?q=TODO&unscoped_q=TODO][search for TODO]]s, [[https://github.com/riscy/melpazoid/issues][raise an issue]]) The checks are a combination of: 1. [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Byte-Compilation.html#Byte-Compilation][byte-compile-file]] @@ -20,12 +18,10 @@ The checks are a combination of: 4. a license checker (in [[https://github.com/riscy/melpazoid/blob/master/melpazoid/melpazoid.py][melpazoid.py]]) 5. some elisp checks (in [[https://github.com/riscy/melpazoid/blob/master/melpazoid/melpazoid.el][melpazoid.el]]) -1--4 are on the [[https://github.com/melpa/melpa/blob/master/.github/PULL_REQUEST_TEMPLATE.md][MELPA checklist]], so you should always try to get those right. In -normal circumstances the build will exit with a failure if there is any -byte-compile or package-lint `error` -- leeway is given for any `warning`. - -The license checker (4) is currently very crude. The elisp checks (5) are not -foolproof, sometimes opinionated, and may raise false positives. +1--4 are on the [[https://github.com/melpa/melpa/blob/master/.github/PULL_REQUEST_TEMPLATE.md][MELPA checklist]]. Normally the build will exit with a failure if +there is any byte-compile or package-lint =error= -- leeway is given for any +=warning=. The license checker (4) is currently very crude. The elisp checks (5) +are not foolproof, sometimes opinionated, and may raise false positives. * Usage The best way to use melpazoid is to add it to your CI (GitHub actions,