Questions for Reviewing Packages

Philip Kaludercic <[email protected]>
Newsgroups gmane.emacs.devel
Message-ID <[email protected]>
Richard Stallman <[email protected]> writes:

> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
>
> Here's a draft for a list of questions to ask about a proposed
> package.  Any suggestions for other questions?

I have a few comments.

> * What is the package name?
>
> * Briefly, what job(s) does it do?

This is usually always given.

> * If it isn't obvious, how does the name
>   relate to the job it does?

This is a good point we can add to contributing.html.

> * Who are the package's principal authors (up to 5)?
>   What is the email address of each?

Why the limitation?  And this is already listed in the package header.

> * What is the package's bug-reporting email address?

Same thing here.

> * Does the package include modules not written in Emacs Lisp?
>   If so, please describe them, and which language each is written in.
>
> * Is the package designed to interact with any specific web sites or
>   internet sites?  If so, please list their names, and state what they
>   do.
>
> * Is the package designed to interact with any specific programs not
>   part of Emacs?  If so, please list their names, describe each, and
>   state which language each is written in.

We can make this too more explicit in contributing.html.  One thing I am
not certain about is why we have to explicitly inquire about the
languages?
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.