Mercurial > p > roundup > code
comparison doc/developers.txt @ 4254:8d3582271a99
Minor update of doc/developers.txt...
...to point to the new resources on www.roundup-tracker.org:
- pointed to the new tracker
- removed references to CVS
- removed "macros": _Roundup CVS, _feature tracker
- hinted at http://www.roundup-tracker.org/code.html and the mailinglist
instead of duplicating information
| author | Bernhard Reiter <Bernhard.Reiter@intevation.de> |
|---|---|
| date | Thu, 17 Sep 2009 09:54:49 +0000 |
| parents | f5d7562bed95 |
| children | aab5dba70839 |
comparison
equal
deleted
inserted
replaced
| 4253:49e3f85e9feb | 4254:8d3582271a99 |
|---|---|
| 17 | 17 |
| 18 All development is coordinated through two resources: | 18 All development is coordinated through two resources: |
| 19 | 19 |
| 20 - roundup-dev mailing list at | 20 - roundup-dev mailing list at |
| 21 http://lists.sourceforge.net/mailman/listinfo/roundup-devel | 21 http://lists.sourceforge.net/mailman/listinfo/roundup-devel |
| 22 - Sourceforge's issue trackers at | 22 - The issue tracker running at |
| 23 https://sourceforge.net/tracker/?group_id=31577 | 23 http://issues.roundup-tracker.org/ |
| 24 | 24 |
| 25 Website, wiki, issue tracker | 25 Website, wiki, issue tracker |
| 26 ---------------------------- | 26 ---------------------------- |
| 27 | 27 |
| 28 1. Log into <username>,roundup@shell.sourceforge.net | 28 1. Log into <username>,roundup@shell.sourceforge.net |
| 31 | 31 |
| 32 | 32 |
| 33 Small Changes | 33 Small Changes |
| 34 ------------- | 34 ------------- |
| 35 | 35 |
| 36 Most small changes can be submitted through the `feature tracker`_, with | 36 Most small changes can be submitted through the issue tracker, with |
| 37 patches attached that give context diffs of the affected source. | 37 patches attached that give context diffs of the affected source. |
| 38 | 38 |
| 39 | 39 |
| 40 SVN Access | 40 SVN Access |
| 41 ---------- | 41 ---------- |
| 42 | 42 |
| 43 To get SVN access, contact richard@users.sourceforge.net. | 43 See http://www.roundup-tracker.org/code.html. |
| 44 For all other questions ask on the development mailinglist. | |
| 44 | 45 |
| 45 | 46 |
| 46 Project Rules | 47 Project Rules |
| 47 ------------- | 48 ------------- |
| 48 | 49 |
| 49 Mostly the project follows Guido's Style (though naming tends to be a little | 50 Mostly the project follows Guido's Style (though naming tends to be a little |
| 50 relaxed sometimes). In short: | 51 relaxed sometimes). In short: |
| 51 | 52 |
| 52 - 80 column width code | 53 - 80 column width code |
| 53 - 4-space indentations | 54 - 4-space indentations |
| 54 - All modules must have a CVS Id line near the top | 55 - All modules must have an Id line near the top |
| 55 | 56 |
| 56 Other project rules: | 57 Other project rules: |
| 57 | 58 |
| 58 - New functionality must be documented, even briefly (so at least we know | 59 - New functionality must be documented, even briefly (so at least we know |
| 59 where there's missing documentation) and changes to tracker configuration | 60 where there's missing documentation) and changes to tracker configuration |
| 60 must be logged in the upgrading document. | 61 must be logged in the upgrading document. |
| 61 - subscribe to roundup-checkins to receive checkin notifications from the | 62 - subscribe to roundup-checkins to receive checkin notifications from the |
| 62 other developers with CVS access | 63 other developers with write access to the source-code repository. |
| 63 - discuss any changes with the other developers on roundup-dev. If nothing | 64 - discuss any changes with the other developers on roundup-dev. If nothing |
| 64 else, this makes sure there's no rude shocks | 65 else, this makes sure there's no rude shocks |
| 65 - write unit tests for changes you make (where possible), and ensure that | 66 - write unit tests for changes you make (where possible), and ensure that |
| 66 all unit tests run before committing changes | 67 all unit tests run before committing changes |
| 67 - run pychecker over changed code | 68 - run pychecker over changed code |
| 107 locale names, usually just 2-letter language codes. `Translating | 108 locale names, usually just 2-letter language codes. `Translating |
| 108 Messages`_ section of this chapter gives useful hints for | 109 Messages`_ section of this chapter gives useful hints for |
| 109 message translators. | 110 message translators. |
| 110 | 111 |
| 111 4. Translated Message Files are compiled into binary form (_`MO` files) | 112 4. Translated Message Files are compiled into binary form (_`MO` files) |
| 112 and stored in ``locale`` directory (but not kept in the `Roundup | 113 and stored in ``locale`` directory (but not kept in the source code |
| 113 CVS`_ repository, as they may be easily made from PO files). | 114 repository, as they may be easily made from PO files). |
| 114 See `Compiling Message Catalogs`_ section. | 115 See `Compiling Message Catalogs`_ section. |
| 115 | 116 |
| 116 5. Roundup installer creates runtime locale structure on the file | 117 5. Roundup installer creates runtime locale structure on the file |
| 117 system, putting MO files in their appropriate places. | 118 system, putting MO files in their appropriate places. |
| 118 | 119 |
| 309 | 310 |
| 310 Roundup overcomes these limitations by using both of these utilities. | 311 Roundup overcomes these limitations by using both of these utilities. |
| 311 This means that you need both `GNU gettext`_ tools and `PO utilities`_ | 312 This means that you need both `GNU gettext`_ tools and `PO utilities`_ |
| 312 to build the Message Template File yourself. | 313 to build the Message Template File yourself. |
| 313 | 314 |
| 314 Latest Message Template File is kept in `Roundup CVS`_ and distributed | 315 Latest Message Template File is kept in the source code repository |
| 315 with `Roundup Source`_. If you wish to rebuild the template yourself, | 316 and distributed with `Roundup Source`_. |
| 317 If you wish to rebuild the template yourself, | |
| 316 make sure that you have both ``xpot`` and ``xgettext`` installed and | 318 make sure that you have both ``xpot`` and ``xgettext`` installed and |
| 317 just run ``gmake`` (or ``make``, if you are on a `GNU`_ system like | 319 just run ``gmake`` (or ``make``, if you are on a `GNU`_ system like |
| 318 `linux`_ or `cygwin`_) in the ``locale`` directory. | 320 `linux`_ or `cygwin`_) in the ``locale`` directory. |
| 319 | 321 |
| 320 For on-site i18n, Roundup provides command-line utility:: | 322 For on-site i18n, Roundup provides command-line utility:: |
| 414 http://www.gnu.org/software/gettext/manual/html_node/gettext_150.html | 416 http://www.gnu.org/software/gettext/manual/html_node/gettext_150.html |
| 415 .. _po filetype plugin: | 417 .. _po filetype plugin: |
| 416 http://vim.sourceforge.net/scripts/script.php?script_id=695 | 418 http://vim.sourceforge.net/scripts/script.php?script_id=695 |
| 417 .. _PO utilities: http://po-utils.progiciels-bpi.ca/ | 419 .. _PO utilities: http://po-utils.progiciels-bpi.ca/ |
| 418 .. _poEdit: http://poedit.sourceforge.net/ | 420 .. _poEdit: http://poedit.sourceforge.net/ |
| 419 .. _Roundup CVS: http://sourceforge.net/cvs/?group_id=31577 | |
| 420 .. _Roundup Source: | 421 .. _Roundup Source: |
| 421 .. _Roundup source distribution: | 422 .. _Roundup source distribution: |
| 422 .. _Roundup binary distribution: | 423 .. _Roundup binary distribution: |
| 423 http://sourceforge.net/project/showfiles.php?group_id=31577 | 424 http://sourceforge.net/project/showfiles.php?group_id=31577 |
| 424 .. _TAL: | 425 .. _TAL: |
| 427 .. _TALES: | 428 .. _TALES: |
| 428 .. _Template Attribute Language Expression Syntax: | 429 .. _Template Attribute Language Expression Syntax: |
| 429 http://dev.zope.org/Wikis/DevSite/Projects/ZPT/TALES%20Specification%201.3 | 430 http://dev.zope.org/Wikis/DevSite/Projects/ZPT/TALES%20Specification%201.3 |
| 430 .. _vim: http://www.vim.org/ | 431 .. _vim: http://www.vim.org/ |
| 431 .. _ZPTInternationalizationSupport: http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZPTInternationalizationSupport | 432 .. _ZPTInternationalizationSupport: http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZPTInternationalizationSupport |
| 432 .. _feature tracker: http://sourceforge.net/tracker/?group_id=31577&atid=402791 | 433 |
| 433 |
