Author: tziade
Date: Tue Mar 28 03:33:01 2006
New Revision: 2740

Added:
   cookbook/trunk/how_to_participate.txt   (contents, props changed)
Log:
added a 'howto participate' document

Added: cookbook/trunk/how_to_participate.txt
==============================================================================
--- (empty file)
+++ cookbook/trunk/how_to_participate.txt       Tue Mar 28 03:33:01 2006
@@ -0,0 +1,79 @@
+How to participate
+__________________
+
+Setting up your sandbox
+=======================
+
+First of all you need to get an access over the svn, ask Tarek.
+
+Then you can get a checkout of the cookcook with a svn co::
+
+    svn co https://svn.z3lab.org/z3lab/cookbook/trunk cookbook
+
+The cookbook is a Zope 3 package, you can add to your instance
+in your lib/python folder. Its tests can be run from the instance::
+
+    bin/test -vp cookbook
+
+You might want to check this document that explains how tests are extracted::
+
+    http://svn.z3lab.org/trac/z3lab/file/cookbook/trunk/tests.txt
+
+
+The server has a commit hook, you can receive mails on each commit,
+just ask for it.
+
+You want to write recipes
+=========================
+
+Recipes are latex files, take a look at the DummyRequest to
+get a clue::
+
+    http://svn.z3lab.org/trac/z3lab/file/cookbook/trunk/recipe00.en.tex
+
+
+If you are under Linux, i really advice you to use Kile, you'll find Kile 
project
+files for each language on the svn.
+
+The recipe lists is holder here::
+
+    http://svn.z3lab.org/trac/z3lab/file/cookbook/trunk/recipe_list.txt
+
+You can just start up your writing, by adding your initial besides the recipe
+you want. If the recipe you want to do is not listed, let's add it but
+please ask me so I validate it.
+
+Keep in mind that Recipe must stay short (max: 5 rendered page) and focus
+on one specific topic.
+
+You want to translate recipes
+=============================
+
+Add your initial besides the recipe, with the translation done. example::
+
+     (fr->en, TZ)
+
+then add your name at the beginning of the latex file:
+
+    \translator{Tarek Ziad´┐Ż}
+
+
+Review process
+==============
+
+We'll probably integrate a review process later, to increase recipe quality,
+language style, etc..
+
+License matters, how the project is driven
+==========================================
+
+I (Tarek) manage the project but contributors are welcome. They all
+appears in the website::
+
+    http://zope-cookbook.org/about
+
+and will always appear on any way the cookbook is shown.
+
+Someone who write or translate a recipe agrees that the recipe becomes part of
+the cookbook, and therefore has its licencing and cannot be reproduced 
somewhere
+else, except the source code.
-- 
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins

Reply via email to