document process some more

Original commit message from CVS:
document process some more
This commit is contained in:
Thomas Vander Stichele 2006-09-02 13:36:44 +00:00
parent 27dcfe7c7f
commit 56c713bc96

View file

@ -1,7 +1,7 @@
Moving around plug-ins between source modules Moving around plug-ins between source modules
--------------------------------------------- ---------------------------------------------
Last updated: 2005-11-18 Last updated: 2006-09-01
How to get your plug-in out of -bad and into -good or -ugly How to get your plug-in out of -bad and into -good or -ugly
----------------------------------------------------------- -----------------------------------------------------------
@ -10,16 +10,39 @@ Since GStreamer 0.9.x, we have four plugin modules: -base, -good, -ugly,
and -bad. Plug-ins are by default added to -bad. They can only move and -bad. Plug-ins are by default added to -bad. They can only move
to -good or -ugly if a number of conditions are met: to -good or -ugly if a number of conditions are met:
PEOPLE
------
- People involved: - People involved:
- There should be a person who is actively going to maintain this element; - There should be a person who is actively going to maintain this element;
presumably this is the person writing the plug-in in the first place presumably this is the person writing the plug-in in the first place
and opening the move request
- There should be a GStreamer hacker who is willing to sponsor the element; - There should be a GStreamer hacker who is willing to sponsor the element;
this would be someone who is going to help out getting all the conditions this would be someone who is going to help out getting all the conditions
met, act as a mentor if necessary,...
- There should be a core developer who verifies that the checklist is
met met
- There should be a core developer who verifies the merge
The three roles can be filled by two people, but not just one. The three roles can be filled by two people, but not just one.
In addition, an admin needs to perform the actual move, which involves
CVS surgery.
PROCESS
-------
- bug in bugzilla gets filed by someone requesting a move from bad
to good/ugly
This is "requesting" the move.
- a second person reviews the request and code, and verifies that the
plugin meets the checklist items below, by commenting on he bug
and giving a rundown of what still needs to be done
This is "sponsoring" the move.
- when the checklist is met, a third person can approve the move.
This is "approving" the move.
- an admin performs the move.
This is "performing" the move. (Are you laughing yet ?)
CHECKLIST
---------
- The plug-in's code: - The plug-in's code:
- should descend from an applicable base class if possible - should descend from an applicable base class if possible
- make use of GST_BOILERPLATE macros - make use of GST_BOILERPLATE macros