Differences between revisions 17 and 18
Revision 17 as of 2015-01-24 18:25:54
Size: 8123
Editor: terri
Comment: Adding detailed dlists project
Revision 18 as of 2015-01-24 18:53:32
Size: 9648
Editor: terri
Comment: Adding plugin idea
Deletions are marked like this. Additions are marked like this.
Line 15: Line 15:
'''Note:''' You can use a vcs of your own choice for playing around, but we accept merge requests only through Launchpad (which uses bzr) for Mailman core and Postorius. '''Note:''' You can use a version control system of your own choice for playing around, but we accept merge requests only through Launchpad (which uses bzr) for Mailman core and Postorius.
Line 18: Line 18:
We encourage you to discuss your doubts with us so that we can help you get up to speed. But the more you are able to demonstrate ability in advance, We encourage you to discuss your questions with us so that we can help you get up to speed. But the more you are able to demonstrate ability in advance,
Line 66: Line 66:
 * Understanding of mailing list communication.  * Understanding of mailing list communication. For example, you should have a rough idea of some answers to the following questions: "How do people talk on mailing lists? What sort of threads would they want to unsubscribe from? What sort of interface would work best for this?" (although be open to working with real users!)
Line 75: Line 75:

=== Build 2-3 Mailman plugins ===

Mailman 3 has a new plugin system that allows people to build rules that run before mail is delivered, but it's not entirely obvious to people how this will work since there aren't any complex plugins built yet. This project would involve choosing a couple of interesting plugins and building them both as useful pieces in their own right but also as examples for developers to build upon later.

Some plugin ideas:
 * Spam Assassin integration. This would involve making it possible for list admins to set a threshold for their list and have Mailman discard any messages with a Spam Assassin score higher than the threshold.
   * This would involve some work in Postorius to add an interface as well as work with Mailman Core for the plugin.
   * Setting up Spam Assassin can be non-trivial, so make sure you know how to do this before proposing this plugin idea!
 * Add your own here!

'''Difficulty Level:'''
 * Intermediate or advanced, since you will be the first person to use the plugin system and will have to be comfortable with suggesting architectural changes if needed

'''More reading:'''
 * A link to Barry's plugin documentation needs to go here.

Google Summer of Code 2015 Ideas Page

GNU Mailman is hoping to participate in Google Summer of Code (GSoC) 2015 and this page consists of some of the project ideas and guidelines on how to participate.

Skills Required

These skills are appreciated but their absence in no way disqualifies anyone from participating. Specific projects may have their desired skills listed along with them.

  • Intermediate Python programming (for instance, you can write list comprehensions, classes, subclasses, and generators, and you at least sometimes use virtual environments, even if you are not yet comfortable making your own decorators)
  • Familiarity with any version control (Mailman core and Postorius uses bzr, !Hyperkitty ues git) (note: this may change for MM core by GSoC if Launchpad gains git support.)
  • Ability to setup your own development environment for Mailman

Note: You can use a version control system of your own choice for playing around, but we accept merge requests only through Launchpad (which uses bzr) for Mailman core and Postorius. However we are planning to switch to git very soon.

We encourage you to discuss your questions with us so that we can help you get up to speed. But the more you are able to demonstrate ability in advance, the more likely we are to choose your application!

Getting Started

Here are some useful links to get you started with Mailman Development.

Mailman is written in Python. Mailman 3 core is compliant only with python3.4 and the rest of the projects work on python2 (2.7+).You are not required to use a virtual machine for Mailman development, although many people prefer to do so.

Development work on Mailman 2.1 has been frozen for some time, so all new project ideas should be related to Mailman 3.

All of the above listed projects are a part of Mailman Project. Your proposal may involve any one of them or a combination of more than one.

Want to get involved?

If you're interested in participating in GSoC 2015 as a student, mentor, or interested community member, you should join the Mailman Developers mailing list: http://mail.python.org/mailman/listinfo/mailman-developers and post any questions, comments, etc. to mailman-developers@python.org. But we want you to go through the resources mentioned above before asking questions, most of the times the answer is in there somewhere. Developers would be more enthusiastic to help you if you yourself have done some ground work.

In addition you may be able to find us on IRC at #mailman on irc.freenode.org.  If no one is available to answer your question, please be patient and post it to the mailing list as well.  (We *are* the developers for Mailman -- unsurprisingly, most of us prefer to communicate via email.)

Mailman has in the past participated under the Python Software Foundation's umbrella, and will again this year.  The PSF has some additional information (including other IRC channels and mailing lists) here: https://wiki.python.org/moin/SummerOfCode/2015

Project Ideas

We're still discussing possible ideas for 2015, and they'll appear here as we sort them out.  If you have another idea you'd like to propose (either as a prospective student, mentor, or interested community member), please send it to mailman-developers@python.org for discussion!  You can also look at older idea lists linked from the Development Home page (Sprints section, near the bottom), but do be careful – many of those ideas are now irrelevant, were rejected, or (yay!) have been implemented.

Dynamic Sublists

Dynamic Sublists is an addition to Mailman by Systers that allows the dynamic creation of topics/sublists that users can then subscribe/unsubscribe from and filter more easily.

More details can be found on the Dynamic Sublists wiki page

We'd like to use dlists in Mailman 3 as a replacement for the old topics system of Mailman 2.

Skills:

  • Understanding of mailing list communication. For example, you should have a rough idea of some answers to the following questions: "How do people talk on mailing lists? What sort of threads would they want to unsubscribe from? What sort of interface would work best for this?" (although be open to working with real users!)

Difficulty Level:

  • This is at least an intermediate task, as the ideal student will have to follow this through Mailman Core, Postorius (to add a web interface for subscribing/unsubscribing) and Hyperkitty (to make the archives aware of the dlists)

More Reading

Build 2-3 Mailman plugins

Mailman 3 has a new plugin system that allows people to build rules that run before mail is delivered, but it's not entirely obvious to people how this will work since there aren't any complex plugins built yet. This project would involve choosing a couple of interesting plugins and building them both as useful pieces in their own right but also as examples for developers to build upon later.

Some plugin ideas:

  • Spam Assassin integration. This would involve making it possible for list admins to set a threshold for their list and have Mailman discard any messages with a Spam Assassin score higher than the threshold.
    • This would involve some work in Postorius to add an interface as well as work with Mailman Core for the plugin.
    • Setting up Spam Assassin can be non-trivial, so make sure you know how to do this before proposing this plugin idea!
  • Add your own here!

Difficulty Level:

  • Intermediate or advanced, since you will be the first person to use the plugin system and will have to be comfortable with suggesting architectural changes if needed

More reading:

  • A link to Barry's plugin documentation needs to go here.

More ideas

This is a tentative brainstorming list! Before dedicating yourself to any of these, please talk to the mailman-developers list.

  • Make mailman core able to localise digests and other mass mails for individual subscribers if administrators turn on full personalization
  • Add new skins/themes to HyperKitty and/or Postorius (see HyperKitty bug 83 and Postorius bug 1196608)

  • Add GitHub API integration (to automatically mail a Mailman list when a repo gets a new GitHub pull request)

  • User profile pages in HyperKitty and Postorius (see HyperKitty bug 74 and Postorius bug 1104497)

  • Write a Mailman API client library in another language (e.g., Go, PHP, JavaScript, Ruby)

  • Gather and surface administrative statistics in Mailman & Postorius, such as number of posts sent, # bounced, # of domains accessed, which lists are quiet and which are busy (see bug 1414169)

  • Add audit trail for user subscriptions and user management changes. Who added them? What checks were made? bug 1414174

Mentor List

The following folks are mentors and administrators for Mailman's 2015 Google Summer of Code effort.  Most mentors, even if they list addresses here, probably prefer that you post to Mailman Developers <mailman-developers@python.org> instead of sending private mail.  That gives you the broadest exposure to all mentors (improves chance of selection, we are not going to get a slot per mentor!), and probably somebody can respond to you relatively quickly if the "obvious suspect" doesn't.

  • Abhilash Raj <raj DOT abhilash1 NO AT HARVEST gmail DOT com> (maxking on #mailman)

  • Barry Warsaw <barry NO AT HARVEST list DOT org> (barry on #mailman) - MM core co-mentor

  • Florian Fuchs <flo DOT fuchs NO AT HARVEST gmail DOT com> (Mailman suborg admin, nick: florianf on freenode)

  • Aurelien Bompard <aurelien NO AT HARVEST bompard DOT org> (abompard on #mailman)

  • Terri Oda <terri NO AT HARVEST toybox DOT ca> (terri on #mailman)

MailmanWiki: DEV/Google_Summer_of_Code_2015 (last edited 2016-03-24 01:40:26 by stephen@xemacs.org)