Changes between Version 29 and Version 30 of Patches


Ignore:
Timestamp:
2013-08-07T22:00:51Z (11 years ago)
Author:
daira
Comment:

minor tweaks; 'design-review-needed' keyword is no longer used

Legend:

Unmodified
Added
Removed
Modified
  • Patches

    v29 v30  
    33Please create a new ticket to track the issue unless your patch addresses an issue that is already ticketed. If you're not sure whether there is a ticket for your issue, just make a new one. Someone will point you in the right direction if your ticket is a duplicate.
    44
    5 We use git as our versoin control system and the tahoe source code is hosted on [https://github.com/tahoe-lafs/tahoe-lafs Github]. Github requires that you have a Github account in order to submit patches, so you will have to create one if you don't already have one. If you are unfamiliar with Github or git we recommend the following resources:
     5We use git as our version control system and the tahoe source code is hosted on [https://github.com/tahoe-lafs/tahoe-lafs Github]. Github requires that you have a Github account in order to submit patches, so you will have to create one if you don't already have one. If you are unfamiliar with Github or git we recommend the following resources:
    66* [https://help.github.com/articles/set-up-git Github - Set up git]
    77* [https://help.github.com/articles/fork-a-repo Github - Fork a repo]
     
    1616Now, hack at Tahoe-LAFS!
    1717
    18 Once you think you have solved the issue run the test suite with `python setup.py trial`. This ensures that you didn't accidentally break something while working on your patch.
     18Once you think you have solved the issue run the test suite with `python setup.py test`. This ensures that you didn't accidentally break something while working on your patch.
    1919
    20 Now that all of the existing unit tests pass, [https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToWriteTests write your own tests] for the ticket if they don't already exist.
     20Now that all of the existing unit tests pass, [https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToWriteTests write your own tests] for the ticket if they don't already exist, and make sure that they pass. Also ensure that `make pyflakes` finds no errors or warnings.
    2121
    2222Finally, push your branch to Github and [https://help.github.com/articles/creating-a-pull-request open a pull request]. Please add the tag `review-needed` to the ticket and add a link to the pull request. If you had trouble writing unit tests for your patch, don't worry. Submit the pull request anyway and add the tag `tests-needed` to the ticket.
     
    2525= Design reviews =
    2626
    27 To request a design review, explain your design (with or without a patch) and then add the [query:keywords~=design-review-needed&status=!closed&group=milestone design-review-needed] tag. Completion of a design review will normally not directly result in a patch being committed. The main goal of a design review is to give the person working on the ticket confidence that there are no show-stopping issues with the approach they are taking, and to get feedback on smaller issues that are useful to take into account before doing further work on a patch.
     27To request a design review, just explain your design (with or without a patch) and ask for feedback. Completion of a design review will normally not directly result in a patch being committed. The main goal of a design review is to give the person working on the ticket confidence that there are no show-stopping issues with the approach they are taking, and to get feedback on smaller issues that are useful to take into account before doing further work on a patch.