changeset 241:2f2681ed8f16

[doc] add good practice section
author Pierre-Yves.David@ens-lyon.org
date Fri, 11 May 2012 11:45:00 +0200
parents ab9ee2eba21e
children 1fc4299ca8e2
files docs/evolve-good-practice.rst docs/index.rst
diffstat 2 files changed, 44 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/evolve-good-practice.rst	Fri May 11 11:45:00 2012 +0200
@@ -0,0 +1,43 @@
+-----------------------------------------
+Good pratice for (early) user of evolve
+-----------------------------------------
+
+Avoid instability
+--------------------------------
+
+The less instability you have the less you need to resolve.
+
+Evolve is not yet able to detect and solve every situation. And your mind is
+not ready neither.
+
+Branch as much as possible
+--------------------------------
+
+This is not MQ you are not constrainted to linear history.
+
+Making a branch per independent branch will help you avoiding instability and conflict.
+
+Rewrite you change only
+------------------------------------------------
+
+There is no descent conflict detection and handling right now. rewriting other
+people changeset garantee that you will get conflict. Communicate with you
+fellow developer before trying to touch other people part. (which is a good
+pratice in any case)
+
+Using multiple branch will help you to achieve this goal.
+
+Prefer pushing unstability than touching other people changeset
+------------------------------------------------------------------
+
+
+If you have children changeset from other people that you don't really care
+about, prefer not altering them that risking a conflict by stabilizing them.
+
+
+Do not get too confident
+---------------------------
+
+This is an experimental extension and a complexe concept. This is beautiful,
+powerful and robust on paper. But the tool and your mind may not be prepared to
+all situation yet.
--- a/docs/index.rst	Fri May 11 11:44:39 2012 +0200
+++ b/docs/index.rst	Fri May 11 11:45:00 2012 +0200
@@ -91,6 +91,7 @@
    :maxdepth: 1
 
    tutorials/tutorial
+   evolve-good-practice
    evolve-faq
    from-mq
    evolve-collaboration