[myhdl-list] MEP guidelines

[Günter D. <dan...@we...>]

Hi,

I would like to suggest, adding some guidelines about the MEP process.
Seeing that the text of an already implemented MEP got changed, I think
it would be helpfull to have some guidelines how the MEP process is
intended.

I think, that especially an already implemented MEP should be kept for
reference as is and not changed later in time. There is the chance, that
the original notion of the implementation gets altered by editing the
MEP it originated from.

My suggestion is to add the text to the MEP introduction page:

http://myhdl.org/doku.php/meps:intro

The text could be based on the Python Enhancement Proposal, found here:

http://www.python.org/dev/peps/pep-0001/

Here is a first draft for a text. The first paragraphs are a copy of the
PEP text, changed according to MyHDL:

---------


MEP stands for MyHDL Enhancement Proposal. A MEP is a design document
providing information to the MyHDL community, or describing a new
feature for MyHDL. The MEP should provide a concise technical
specification of the feature and a rationale for the feature.

We intend MEPs to be the primary mechanisms for proposing new features,
for collecting community input on an issue, and for documenting the
design decisions that have gone into MyHDL. The MEP author is
responsible for building consensus within the community and documenting
dissenting opinions.

MEPs are maintained on the MyHDL wiki page. The page history resembles
the development history of the document.

Main responsibility of a MEP lies with its author. Before opening a new
MEP, its idea should be discussed on the MyHDL mailing list.

In the development phase the MEP gets the status "Draft" assigned. Fully
developed and provided with a functional implementation, the MEP can get
the status "Final", documenting that the content of the MEP is ready to
be implemented into MyHDL.

Once the MEP has the status "Final" and its content got added to the
source code, the MyHDL version will be added to the MEP document. From
this time, the text of the document will be frozen.

------------


Cheers, Guenter