2 new commits in todo: https://bitbucket.org/nvdaaddonteam/todo/commits/11f20149aaf8/ Changeset: 11f20149aaf8 Branch: None User: josephsl Date: 2013-05-20 09:41:09 Summary: Guidelines: added a word on branches. Also fixed the URL for the template.: Affected #: 1 file diff --git a/guideLines.txt b/guideLines.txt index 25f265c..5a9c08d 100644 --- a/guideLines.txt +++ b/guideLines.txt @@ -4,7 +4,7 @@ The following is a set of guidelines that current and potential add-on authors s ## General ## -1. Use the addonTemplate from http://bitbucket.org/nvdaaddonteam/addon-template +1. Use the addonTemplate from http://bitbucket.org/nvdaaddonteam/addonTemplate 2. Addon name should not contain "nvda", "plugin", "appmodule", "globalPlugin" as part of its name, the user should not have to worry about implementational issues. @@ -23,7 +23,7 @@ minor revision, 3.1, 3.2 etc, add the new languages to the readme.mdown. 4. git tag the release. 5. After making a release, update the version to indicate that its under development for the next version, i.e. 3.1-dev. 6. Releases should be made no closer than 2 weeks apart, to allow translators to do their work, unless fixing a chritical/showstopper bug. -7. Announce the availibility of the new version on mailinglists. +7. Announce the availibility of the new version on various NVDA mailing lists (e.g. NVDA add-ons list). ## Coding Style ## @@ -35,6 +35,7 @@ the creator of the message. 4. Translatable messages should have a translator comment to explain where/when the message is presented, so that the translator can test the message easily when s/he installs the addon. +5. When working on a new or modifying a major feature, create/use branches other than master branch, as it helps merging and code review (via pull request) process and to find bugs easily. ## Documentation and key bindings ## https://bitbucket.org/nvdaaddonteam/todo/commits/3d97409fa0eb/ Changeset: 3d97409fa0eb Branch: master User: josephsl Date: 2013-05-20 09:41:41 Summary: Merge branch 'master' of https://bitbucket.org/nvdaaddonteam/todo Affected #: 1 file diff --git a/guideLines.txt b/guideLines.txt index 5a9c08d..3ff8aae 100644 --- a/guideLines.txt +++ b/guideLines.txt @@ -20,7 +20,7 @@ Dashes in names are currently not supported by the automated system. 3.0. 3. When making a release that has only translation updates, update the minor revision, 3.1, 3.2 etc, add the new languages to the readme.mdown. -4. git tag the release. +4. git tag the release, note special git push for tags. 5. After making a release, update the version to indicate that its under development for the next version, i.e. 3.1-dev. 6. Releases should be made no closer than 2 weeks apart, to allow translators to do their work, unless fixing a chritical/showstopper bug. 7. Announce the availibility of the new version on various NVDA mailing lists (e.g. NVDA add-ons list). @@ -40,4 +40,4 @@ message easily when s/he installs the addon. ## Documentation and key bindings ## 1. If you are adding new keyboard commands as part of your add-on, be sure to consult NVDA Command Quick Reference and other community supported add-on commands before assigning a new command. -2. Please provide a readme file listing changes between versions, shortcut keys (if any) and usage notes and other information, see one of the other git repos for examples. +2. Please provide a readme.mdown file listing changes between versions, shortcut keys (if any) and usage notes and other information, see one of the other git repos for examples. Repository URL: https://bitbucket.org/nvdaaddonteam/todo/ -- This is a commit notification from bitbucket.org. You are receiving this because you have the service enabled, addressing the recipient of this email. ---------------------------------------------------------------- NVDA add-ons Central: A list for discussing NVDA add-ons To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. To unsubscribe, send an email with the subject line of "unsubscribe" (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. If you have questions for list moderators, please send a message to nvda-addons-moderators@xxxxxxxxxxxxx.