docs/evolve-good-practice.rst
author Pierre-Yves David <pierre-yves.david@ens-lyon.org>
Sat, 25 Aug 2012 14:43:34 +0200
branchstable
changeset 519 9825c7da5b54
parent 357 b398e9c2dbd1
child 527 b81193ef3488
permissions -rw-r--r--
ensure all file have a copyright notice
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
519
9825c7da5b54 ensure all file have a copyright notice
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 357
diff changeset
     1
.. Copyright 2011 Pierre-Yves David <pierre-yves.david@ens-lyon.org>
9825c7da5b54 ensure all file have a copyright notice
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 357
diff changeset
     2
..                Logilab SA        <contact@logilab.fr>
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     3
-----------------------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     4
Good pratice for (early) user of evolve
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     5
-----------------------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     6
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
     7
Avoid unstability
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     8
--------------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
     9
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    10
The less unstability you have the less you need to resolve.
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    11
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    12
Evolve is not yet able to detect and solve every situation. And your mind is
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    13
not ready neither.
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    14
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    15
Branch as much as possible
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    16
--------------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    17
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    18
This is not MQ, you are not constrainted to linear history.
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    19
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    20
Making a branch per independent branch will help you avoid unstability
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    21
and conflict.
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    22
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    23
Rewrite you change only
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    24
------------------------------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    25
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    26
There is no descent conflict detection and handling right now.
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    27
Rewriting other people's changesets guarantees that you will get
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    28
conflicts. Communicate with your fellow developers before trying to
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    29
touch other people's work (which is a good pratice in any case).
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    30
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    31
Using multiple branch will help you to achieve this goal.
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    32
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    33
Prefer pushing unstability than touching other people changeset
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    34
------------------------------------------------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    35
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    36
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    37
If you have children changesets from other people that you don't really care
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    38
about, prefer not altering them to risking a conflict by stabilizing them.
241
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    39
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    40
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    41
Do not get too confident
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    42
---------------------------
2f2681ed8f16 [doc] add good practice section
Pierre-Yves.David@ens-lyon.org
parents:
diff changeset
    43
357
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    44
This is an experimental extension and a complex concept. This is beautiful,
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    45
powerful and robust on paper, but the tool and your mind may not be prepared for
b398e9c2dbd1 doc: English proofreading
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 241
diff changeset
    46
all situations yet.