Skip to content

Instantly share code, notes, and snippets.

@thibaudcolas
Last active April 11, 2024 09:36
Show Gist options
  • Save thibaudcolas/bd7b6c630ff9ee2a9b1ca6deda9568af to your computer and use it in GitHub Desktop.
Save thibaudcolas/bd7b6c630ff9ee2a9b1ca6deda9568af to your computer and use it in GitHub Desktop.
Draft: Package maintainers DSF working group charter

Package Maintainers Working Group

Scope of responsibilities

This group supports package maintainers in the Django ecosystem. Packages are an important part of the experience of using Django, and their maintainers can benefit from different forms of support than Django contributors and users.

The goals of the group are:

  • To facilitate discussions and share knowledge about common issues or tasks in package maintenance.
  • To coordinate efforts to improve the health and quality of packages in the Django ecosystem.
  • To advocate for the needs of package maintainers in the Django community.

This is a broad definition of the group’s remit. Current members select specific activities to undertake based on their interests and availability. See Group activities for examples of what the group may choose to do.

Delegated responsibilities

With regards to Django Software Foundation responsibilities and resources, the group operates with:

  • No special powers delegated by the board to the group.
  • No specific "Django Software Foundation" actions the group can take directly.

Any request for funding or resources are made via existing processes outside of this group. This can be revised in the future as and when the group identifies specific recurring needs.

Membership

  • Chair:
  • Co-Chair:
  • Board Liaison (must be an active Board member; may be the same as Chair/Co-Chair):
  • Other members:
    • Thibaud Colas

Eligibility

Membership is open to all Individual Members of the Django Software Foundation.

How to join

To join, members must express an interest in the #packages channel of the Django Discord server, or reach out to a current group member.

Candidates will be invited to an upcoming Working Group meeting to discuss their interest and potential contributions, after which they will be voted in by current group members (50%+1).

Members will be selected for the group based on their interest in the group’s goals and ability to contribute to them.

How to exit

Members join the group for a 6-month term. At the end of this term, they need to opt into staying involved to keep being a member of the group.

If any member wishes to leave the group before the end of their term, they can do so without a vote.

Members can propose a vote on removing a member from the working group. This needs 50%+1 agreement.

Budget

No allocated budget, the group makes ad-hoc requests for funding or resources as needed.

Group communications

The group communicates asynchronously via:

  • The public #packages channel on the Django Discord server.
  • Appropriate public sections of the Django Forum.
  • GitHub issues and pull requests in a new django/package-maintainers-wg repository.
  • Collaborative documents set up in the Django Software Foundation’s Google Workspace.
  • A new private #package-maintainers-wg` channel on the Django Discord server for internal discussions.

The group will also meet every month via video call.

Reporting

The group will share highlights from the group’s current activities on a monthly basis.

Appendix

Group activities

As an illustration of the group’s remit, here are possible activities members could take part in.

Support Django version compatibility efforts

As Django regularly releases new versions, it’s an ongoing effort to ensure packages are compatible with new releases.

Group members can support maintainers in this effort by:

  • Creating a shared calendar with Django release dates and deadlines.
  • Creating communication channels for package maintainers to coordinate compatibility changes for a specific release.
  • Recommending appropriate automation, such as django-upgrade or how to set up Django pre-releases in Continuous Integration.

Share packaging best practices

The group can work on create, maintain, or curate best practices for Django package maintainers. For example, the official Advanced tutorial: How to write reusable apps, or packaging-focused sections on third-party resources like awesome-django.

Those best practices can cover aspects like:

  • Use of the django_ prefix for app names (see Change reusable apps naming recommendation).
  • Recommended Python, Django, browser, operating system support policies to align with those of Django itself.
  • How to set up Continuous Integration for Django packages.

Facilitate community-driven maintenance

Group members can liaise with organizations dedicated to sharing maintenance efforts, such as Jazzband or Wagtail Nest. Or work directly with packages in need of new maintainers to find new candidates. This can involve:

  • Sharing calls for new package maintainers
  • Coordinating trusted volunteer open source “roadies” familiar with package ownership transfers.
  • Facilitating participation in mentoring programs such as Google Summer of Code or Djangonaut Space.
  • Providing support for tasks requiring very specific expertise, like funding avenues or vulnerability reports handling.

Review the package ecosystem

The group can organize periodic reviews of the package ecosystem to assess its health, for other efforts to make more informed decisions.

  • Statistics on compatible Django / Python versions
  • Package health and popularity metrics
  • Django Developers Survey questions relevant to package maintenance
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment