OPENCOLLECTIVE.rst

Overview

This file serves as a documentation page describing how the pytest core team manages their Open Collective presence and related activities. Open Collective is an online platform that facilitates transparent funding and financial management for open-source communities. The document explains the purpose of the Open Collective fund for pytest, how the funds are utilized, guidelines for core contributors to submit invoices for maintenance work, and administrative access and responsibilities related to the Open Collective dashboard.

This file is primarily informational and does not contain executable code. It is part of the project's documentation suite, helping contributors and community members understand the funding and governance aspects related to pytest's Open Collective.

Detailed Explanation

Purpose and Content Sections

• What is it
  Describes Open Collective as an online funding platform that allows communities to raise and share funds transparently. It emphasizes that Open Collective is the chosen platform for pytest to receive one-time or recurring donations.

• Funds
  Explains how donated funds are allocated:

  • Overall maintenance of pytest

  • Local developer sprints

  • Merchandising (e.g., stickers for conferences)

  • Future developer gatherings or sprints

  It also outlines that core contributors regularly contributing to pytest may invoice for maintenance hours via Open Collective, suggesting a guideline to bill amounts comparable to the monthly Tidelift subscription payments.

• Admins
  Lists that a select group of people have admin access to the Open Collective dashboard and are part of the @pytest-dev/opencollective-admins GitHub team. It invites core contributors interested in operations and maintenance of the Open Collective presence to get involved.

References and Links

The document uses reStructuredText hyperlink targets linking to:

• Open Collective page for pytest

• Tidelift subscription page

• GitHub teams for core contributors and Open Collective admins

Usage Example

Since this is a documentation file without executable code, usage involves reading and following the guidelines provided:

• Core contributors can refer to the Funds section to understand how to invoice maintenance hours.

• Contributors interested in Open Collective administration can reach out to the specified admin team.

• Community members can use the links to explore the funding platform or join the relevant teams.

Important Implementation Details

• This file is written in reStructuredText (RST), a lightweight markup language commonly used for Python project documentation.

• The document is structured with clear headers and sections to organize information logically.

• It uses external hyperlink references to avoid cluttering the text with URLs.

• There are no algorithms or programmatic elements; instead, it serves as a governance and process document.

Interaction with Other Parts of the System

• This documentation is part of the pytest project’s documentation set, helping contributors and users understand the project’s funding mechanism.

• It links to GitHub teams and external platforms (Open Collective, Tidelift), integrating community governance and financial management with the project’s collaborative infrastructure.

• The document complements technical documentation by adding transparency and process clarity around funding and contributor compensation.

Mermaid Diagram: Document Structure

flowchart TD
    A[OPENCOLLECTIVE.rst] --> B[What is it]
    A --> C[Funds]
    A --> D[Admins]
    B --> E[Open Collective platform description]
    C --> F[Fund usage]
    C --> G[Contributor invoicing guidelines]
    D --> H[Admin team info]
    D --> I[Invitation to contributors]

    classDef section fill:#f9f,stroke:#333,stroke-width:1px,color:#000;
    class B,C,D section;

Summary

`OPENCOLLECTIVE.rst` is a non-code documentation file detailing the pytest project's usage of the Open Collective platform for funding. It explains the purpose of the funds, guidelines for contributors to invoice maintenance work, and the roles of admins managing the collective. This document is essential for transparency and community coordination around the project's financial aspects and complements the technical documentation by describing governance and operational workflows.