Changes between Version 6 and Version 7 of WomenOutreach2013

04/05/2013 09:59:50 AM (5 years ago)
Itamar Turner-Trauring



  • WomenOutreach2013

    v6 v7  
    3232=== Outreach Program for Women internship project description ===
     34Here are some project ideas you might work on; we are open to discussing other ideas, and are working on coming up with more.
    3436'''Deferred Cancellation'''
    4850Twisted is broken into several subprojects: core networking, web, email, instant messaging, etc.. For this internship, you'll have an opportunity to become an expert in a subproject that interests you by working on everything from documentation and example programs to ticket triage, bug fixes, and new features. You can move between the goals below as quickly as you want based on your comfort level: if you want to dive right into bug fixes, awesome!
    50 '''Goal !#1: Review and improve documentation'''
     52Goal !#1: Review and improve documentation
    5153 * Audit the examples, and make sure they have a high-level description and specify how they are run.
    5254 * Audit the HOWTOs for use of deprecated APIs, coding standard violations, broken links, etc. and then update them. A newcomer's perspective is *tremendously* valuable here.
    5355 * Identify missing examples and HOWTOs based on IRC, mailing list, and stack overflow feedback, and add them.
    5456 * This is an excellent way to get a feel for the Twisted code base and the networking protocols of your subproject.
    55 '''Goal #2: Test suite cleanup'''
     57Goal #2: Test suite cleanup
    5658 * Help us clean up the code base by removing deprecations and fixing deprecation warnings.
    5759 * Debug and fix some of our recurring sporadic test failures.
    5961 * You'll have a fleet of BuildBot machines at your disposal to test changes!
    6062 * This is a great way to get a feel for how to write unit tests in Twisted, and to develop a solid test-driven development and coding standards discipline -- qualities future employers and co-workers will love!
    61 '''Goal #3: Improve API documentation and test coverage'''
     63Goal #3: Improve API documentation and test coverage
    6264 * Everything that gets us to closer to 100% API documentation and test coverage is making Twisted more accessible and regression-proof.
    63 '''Goal #4: Make progress on stalled subproject tickets'''
     65Goal #4: Make progress on stalled subproject tickets
    6466 * We have a lot of tickets that just need tests, documentation, or one more round of work based on review feedback to land. Help bring some of these tickets across the finish line!
    65 '''Goal #5: Work on features for your subproject'''
     67Goal #5: Work on features for your subproject
    6668 * There are some great open feature tickets looking for a champion. With your experience in Goals 1-4 you are an expert on this subproject and well-equipped to work on them.