Changes between Version 15 and Version 16 of CommitGuides

Timestamp:

10/13/08 21:44:29 (16 years ago)

Author:

Peter Kovacs

Comment:

--

CommitGuides

@@ -5 +5 @@
  - When you start implementing a new feature, bug fix etc, always do it '''on the top of the [http://lemon.cs.elte.hu/hg/lemon/ main repository]''', not on the top of your last local commit.
  - Read and follow the [CodingStyle Coding Style] conventions.
-   - For newly created or ported files you probably want to run the [source:scripts/update-copyright-header.sh update-copyright-header.sh] script to maintain the standard Lemon copyright header.
- - Be very careful not to add unnecessary files (but to add everything that is necessary) 
- - Do not add generated files into the repository. 
- - Do not add test files except very small ones.
+   - Use the standard LEMON copyright header.
+ - Be very careful not to add unnecessary files (but to add everything that is necessary).
+   - Do not add generated files into the repository. 
+   - Do not add test files except very small ones.
  - Do not do changes that are irrelevant to the main purpose of the commit
    - For example do ''not'' do whitespace changes and reformatting unless it is especially needed.
  - If new files added, adjust the build environment config files, as well
-   - the '''{{{Makefile.am}}}''' in the related directory for autotool
-   - the '''{{{CMakeLists.txt}}}''' in the related directory for CMake
+   - the '''{{{Makefile.am}}}''' in the related directory for autotool,
+   - the '''{{{CMakeLists.txt}}}''' in the related directory for CMake.
  - Before you commit revise your changes (e.g. with '''hg status''' and '''hg diff'''). Be sure
-   - not to do whitespace changes. (Emacs' '''ediff''', or '''kdiff3''' will help you in getting rid of them.)
+   - not to do whitespace changes (Emacs' '''ediff''' or '''kdiff3''' will help you in getting rid of them),
    - not to make reordering of declarations unless it is really necessary. If you must, do it in a separate changeset.
  - Make sure that '''{{{make check}}}''' passes without any compilation warning for each commit with {{{g++-4.3}}}. 
-   - When files are renamed or new ones added also check the changset with '''{{{make distcheck}}}'''
+   - When files are renamed or new ones added also check the changset with '''{{{make distcheck}}}'''.
  - At each point, changes should be "clean", i.e. to be self-contained, and not include any changesets that were false starts. 
-   - If you are working on a more substantial new feature or improvement, you probably want to commit frequently in order to make it possible the revert the changes that turn to be a bad idea later. Feel free to do that, but before you share your changes with others, you should clean your repository by removing the unwanted commits and concatenating those actually belong together. Here is a nice description how to do that: http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks 
+   - If you are working on a more substantial new feature or improvement, you probably want to commit frequently in order to make it possible the revert the changes that turn to be a bad idea later. Feel free to do that, but before you share your changes with others, you should clean your repository by removing the unwanted commits and concatenating those actually belong together. Here is a nice description how to do that: [http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks].
  - When you add a new algorithm or data structure:
    - Take the hassle to write a complete doxygen documentation as well.
@@ -26 +26 @@
    - Also provide an exhaustive test case, whenever it makes sense. 
  - When you port files from the SVN repository:
-   1. Run the '''{{{scripts/rename-graphs}}}''' and the '''{{{scripts/unify-sources.sh}}}''' script for all the files you would like to port.
-   1. Check the renamings (e.g. {{{source()}}} and {{{target()}}} should be manually renamed to {{{u()}}} and {{{v()}}} for undirected graphs).
+   1. Run the '''{{{tools/lemon-0.x-to-1.x.sh}}}''' and the '''{{{scripts/unify-sources.sh}}}''' scripts for all the files you would like to port.
+   1. Check the renamings (e.g. {{{source()}}} and {{{target()}}} should be manually renamed to {{{u()}}} and {{{v()}}} for undirected graphs). See the ''Migration Guide'' in the documentation for more information.
    1. Also port the related test files, if there are any.
      - Run the rename and unify scripts for the test files, too.