Skip to content

PDEP decision making #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 19 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 156 additions & 24 deletions web/pandas/pdeps/0001-purpose-and-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,33 @@

- Created: 3 August 2022
- Status: Accepted
- Discussion: [#47444](https://github.com/pandas-dev/pandas/pull/47444)
- Author: [Marc Garcia](https://github.com/datapythonista)
- Revision: 1
- Discussion: [#47444](https://github.com/pandas-dev/pandas/pull/47444),
[#51417](https://github.com/pandas-dev/pandas/pull/51417)
- Author: [Marc Garcia](https://github.com/datapythonista),
[Noa Tamir](https://github.com/noatamir)
- Revision: 2

## PDEP definition, purpose and scope

A PDEP (pandas enhancement proposal) is a proposal for a **major** change in
pandas, in a similar way as a Python [PEP](https://peps.python.org/pep-0001/)
or a NumPy [NEP](https://numpy.org/neps/nep-0000.html).

Bug fixes and conceptually minor changes (e.g. adding a parameter to a function)
are out of the scope of PDEPs. A PDEP should be used for changes that are not
immediate and not obvious, and are expected to require a significant amount of
discussion and require detailed documentation before being implemented.

PDEP are appropriate for user facing changes, internal changes and organizational
discussions. Examples of topics worth a PDEP could include moving a module from
pandas to a separate repository, a refactoring of the pandas block manager or
a proposal of a new code of conduct.
Bug fixes and conceptually minor changes (e.g. adding a parameter to a function) are out of the
scope of PDEPs. A PDEP should be used for changes that are not immediate and not obvious, when
everybody in the pandas community needs to be aware of the possibility of an upcoming change.
Such changes require detailed documentation before being implemented and frequently lead to a
significant discussion within the community.

PDEPs are appropriate for user facing changes, internal changes and significant discussions.
Examples of topics worth a PDEP could include substantial API changes, breaking behavior changes,
moving a module from pandas to a separate repository, or a refactoring of the pandas block manager.
It is not always trivial to know which issue has enough scope to require the full PDEP process.
Some simple API changes have sufficient consensus among the core team, and minimal impact on the
community. On the other hand, if an issue becomes controversial, i.e. it generated a significant
discussion, one could suggest opening a PDEP to formalize and document the discussion, making it
easier for the wider community to participate. For context, see
[the list of issues that could have been a PDEP](#List-of-issues).

## PDEP guidelines

Expand All @@ -40,31 +48,89 @@ consider when writing a PDEP are:

### PDEP authors

Anyone can propose a PDEP, but in most cases developers of pandas itself and related
projects are expected to author PDEPs. If you are unsure if you should be opening
an issue or creating a PDEP, it's probably safe to start by
[opening an issue](https://github.com/pandas-dev/pandas/issues/new/choose), which can
be eventually moved to a PDEP.
Anyone can propose a PDEP, but a core member should be engaged to advise on a proposal made by
non-core contributors. To submit a PDEP as a community member, please propose the PDEP concept on
[an issue](https://github.com/pandas-dev/pandas/issues/new/choose), and find a pandas team
member to collaborate with. They can advise you on the PDEP process and should be listed as an
advisor on the PDEP when it is submitted to the PDEP repository.

### Workflow and Decision-Making Process

We decided to define discussion and voting periods to enable automation, and reduce
communication hurdles, but not to enforce restrictions. In all the following, if the
discussion needs more or less time, one could start the vote sooner, or move the PDEP back to
draft.

### Workflow
#### Workflow

The possible states of a PDEP are:

- Draft
- Under discussion
- Accepted
- Implemented
- Rejected

Next is described the workflow that PDEPs can follow.
The following describes when and how the PDEP status changes.


#### Submitting a PDEP

Proposing a PDEP is done by creating a PR adding a new file to `web/pdeps/`.
The file is a markdown file, you can use `web/pdeps/0001.md` as a reference
for the expected format.

The initial status of a PDEP will be `Status: Under discussion`. This will be changed
to `Status: Accepted` when the PDEP is ready and have the approval of the core team.
The initial status of a PDEP will be `Status: Draft`. This will be changed to
`Status: Under discussion` by the author(s), when they are ready to proceed with the descision
making process.

#### Schedule
A PDEP discussion will remain open for up to 60 days. This period aims to enable participation
from volunteers, who might not always be available to respond quickly, as well as provide ample
time to make changes based on suggestions and considerations offered by the participants.
Similarly, the following voting period will remain open for 15 days.

To enable and encourage discussions on PDEPs, we follow a notification schedule. At each of the
following steps, the pandas team, and the pandas dev mailing list are notified via GitHub and
E-mail:
- Once a PDEP is ready for discussion.
- After 30 discussion days, with 30 days remaining for discussion.
- After 45 discussion days, with 15 days remaining for discussion.
- In case 15 days passed without any new comments, the authors may close the discussion period
and open the voting period.
- Once the voting period starts, after 60 days or in case of an earlier vote, with 15 days
remaining for voting.
- After 10 voting days, with 5 days remaining for voting.

#### Casting Votes
As the voting period starts, a VOTE issue is created which links to the PDEP discussion issue.
Each voting member may cast a vote by adding one of the following comments:

- +1: approve.
- 0: abstain.
- Reason: A one sentence reason is required.
- -1: disapprove
- Reason: A one sentence reason is required.
A disapprove vote requires prior participation in the PDEP discussion issue.

Once the voting period ends, any voter may tally the votes in a comment, using the format: x-y-z,
where x stands for the total of approving, y of abstaining, and z of disapproving votes cast.

#### Quorum and Majority
For a PDEP vote to result in accepting the proposal, a quorum is required. All votes (including
abstentions) are counted towards the quorum. The quorum is computed as the lower of these two
values:

- 11 voting members.
- 50% of voting members.

Given a quorum, a majority of 75% of the non-abstaining votes is required as well, i.e. 75% of
the approving and disapproving votes must be in favor.

Thus, abstaining votes count towards a quorum, but not towards a majority. A voting member might
choose to abstain when they have participated in the discussion, have some objections to the
proposal, but do not wish to stop the proposal from moving forward, nor indicate their full
support.

#### Accepted PDEP

Expand Down Expand Up @@ -98,7 +164,7 @@ PDEPs, since there are discussions that are worth having, and decisions about
changes to pandas being made. They will be merged with `Status: Rejected`, so
there is visibility on what was discussed and what was the outcome of the
discussion. A PDEP can be rejected for different reasons, for example good ideas
that aren't backward-compatible, and the breaking changes aren't considered worth
that are not backward-compatible, and the breaking changes are not considered worth
implementing.

#### Invalid PDEP
Expand All @@ -111,7 +177,7 @@ good as an accepted PDEP, but where the final decision was to not implement the

## Evolution of PDEPs

Most PDEPs aren't expected to change after accepted. Once there is agreement in the changes,
Most PDEPs are not expected to change after they are accepted. Once there is agreement on the changes,
and they are implemented, the PDEP will be only useful to understand why the development happened,
and the details of the discussion.

Expand All @@ -123,6 +189,72 @@ be edited, its `Revision: X` label will be increased by one, and a note will be
to the `PDEP-N history` section. This will let readers understand that the PDEP has
changed and avoid confusion.

## <a id="List-of-issues"></a> List of issues that could have been PDEPs for context
### Clear examples for potential PDEPs:

- Adding a new parameter to many existing methods, or deprecating one in many places. For example:
- The `numeric_only` deprecation affected many methods and could have been a PDEP.
- Adding a new data type has impact on a variety of places that need to handle the data type.
Such wide-ranging impact would require a PDEP. For example:
- `Categorical` ([GH-7217][7217], [GH-8074][8074]), `StringDtype` ([GH-8640][8640]), `ArrowDtype`
- A significant (breaking) change in existing behavior. For example:
- Copy/view changes ([GH-36195][36195])
- Support of new Python features with a wide impact on the project. For example:
- Supporting typing within pandas vs. creation of `pandas-stubs` ([GH-43197][43197],
[GH-45253][45253])
- New required dependency.
- Removing module from the project or splitting it off to a separate repository:
- Moving rarely used I/O connectors to a separate repository [GH-28409](28409)
- Significant changes to contributors' processes are not going to have an impact on users, but
they do benefit from structured discussion among the contributors. For example:
- Changing the build system to meson ([GH-49115][49115])

### Borderline examples:
Small changes to core functionality, such as `DataFrame` and `Series`, should always be
considered as a PDEP candidate as it will likely have a big impact on users. But the same types
of changes in other functionalities would not be good PDEP candidates. That said, any discussion,
no matter how small the change, which becomes controversial is a PDEP candidate. Consider if more
attention and/or a formal decision-making process would help. Following are some examples we
hope can help clarify our meaning here:

- API breaking changes, or discussion thereof, could be a PDEP. For example:
- `value_counts` result rename ([GH-49497][49497]). The scope does not justify a PDEP at first, but later a
discussion about whether it should be executed as a breaking change or with deprecation
emerges, which could benefit from the PDEP process.
- Adding new methods or parameters to an existing method typically will not require a PDEP for
non-core features. For example:
- Both `dropna(percentage)` ([GH-35299][35299]), and `Timestamp.normalize()` ([GH-8794][8794])
would not have required a PDEP.
- On the other hand, `DataFrame.assign()` might. While it is a single method without backwards
compatibility concerns, it is also a core feature and the discussion should be highly visible.
- Deprecating or removing a single method would not require a PDEP in most cases. For example:
- `DataFrame.xs` ([GH-6249][6249]) is an example of deprecations on core features that would be
a good candidate for a PDEP.
- Changing the default value of parameters in a core pandas method is another edge case. For
example:
- Such changes in `dropna`, `DataFrame.groupby`, or in `Series.groupby` could be PDEPs.
- New top level modules and/or exposing internal classes. For example:
- Add `pandas.api.typing` ([GH-48577][48577]) is relatively small and would not necessarily
require a PDEP.


### PDEP-1 History

- 3 August 2022: Initial version
- 3 August 2022: Initial version ([GH-47938][47938])
- 15 February 2023: Version 2 ([GH-51417][51417]) clarifies the scope of PDEPs and adds examples

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add to History (once version 2 is merged)


[7217]: https://github.com/pandas-dev/pandas/pull/7217
[8074]: https://github.com/pandas-dev/pandas/issues/8074
[8640]: https://github.com/pandas-dev/pandas/issues/8640
[36195]: https://github.com/pandas-dev/pandas/issues/36195
[43197]: https://github.com/pandas-dev/pandas/issues/43197
[45253]: https://github.com/pandas-dev/pandas/issues/45253
[49497]: https://github.com/pandas-dev/pandas/issues/49497
[35299]: https://github.com/pandas-dev/pandas/issues/35299
[8794]: https://github.com/pandas-dev/pandas/issues/8794
[6249]: https://github.com/pandas-dev/pandas/issues/6249
[48577]: https://github.com/pandas-dev/pandas/issues/48577
[49115]: https://github.com/pandas-dev/pandas/pull/49115
[28409]: https://github.com/pandas-dev/pandas/issues/28409
[47938]: https://github.com/pandas-dev/pandas/pull/47938
[51417]: https://github.com/pandas-dev/pandas/pull/51417