Mailman Developer Resources

Thank you for contributing to Mailman! Please also see the Mailman 3 release notes.

See the quick start.

Contributing to Mailman, step 1: Git and Gitlab

Mailman 3's source code is published in git. Project management is available on Gitlab. We switched from Bazaar on Launchpad on May 4th, 2015. Previous to that, we switched from Subversion on SourceForge on June 22, 2007.

Please note: Mailman 2.1 development continues to be hosted in Bazaar on Launchpad.

For now, the Mailman 3 branch on Launchpad will continue to be available in read-only mode.

Contributing to Mailman, step 2: Contribution workflow process

  1. A developer has an idea for an enhancement.  They discuss it on the mailman-developers mailing list. For higher bandwidth discussions we can use irc (#mailman channel on irc://irc.freenode.net). Channel logs are available.

  2. Developers can clone our git repository, push their own branches, and submit a merge request against the official branches.

  3. If the idea is appropriate for GNU Mailman and we decide to include it, FSF must get copyright assignments from the developer. See below. Do this early, since it can take some time to get all the paperwork to the FSF.

Branch development guidelines

  • Branches should be self-contained:  Include documentation, a NEWS entry, and tests.  Ideally, there would be one bug for every branch.
  • Be sure your branch does not provoke any regressions. Run tox on your branch and be sure everything passes. Eventually, we'll enable CI on Gitlab so you'll know immediately whether your branch is ready for merging.

  • Branches should be as small as possible. The smaller the branch the easier it is to review.

Mailman is a GNU project with the majority of the copyrights being held by the Free Software Foundation. We therefore request that developers who contribute code, assign their copyrights in their Mailman contribution to the FSF. To do this, you first need to submit a GNU copyright assignment request form containing some basic information, and then fill out the form that the FSF sends you. Please let us know after you've sent the second form so that we can track your contribution. The FSF often doesn't tell us in a timely manner when such forms have been received.

Version-specific resources

Mailman's developers are currently focused mostly on working towards the release of Mailman 3.0.

Sprints

Initiatives and proposals

Suggestions

People seem to have trouble figuring out where to make suggestions or feature requests. There is a suggestions page here, or you may wish to start a discussion on the mailman-developers list

Relevant RFCs, references, and standards

Here are some useful RFCs, references and drafts:

Best practices:


MailmanWiki: DEV/Home (last edited 2015-06-03 14:33:35 by barry)