DOC: hardcode contributors for 0.24.x releases
State: closed

xref https://github.com/pandas-dev/pandas/issues/24949#issuecomment-460170519

The actual contributors are not picked up by our `.. contributors::` sphinx extension, as the commit authors area lost in the backporting process using MeeseeksDev.



Labels:
name: Docs

Comments:
@TomAugspurger are you OK with this? In that case, will do the same for 0.24.2 as well.
Yeah, good for now.

Back when we backported manually, we passed the `-x` flag to include "cherry picked from"...
Does anyone know if this is what let GitHub retain the author information?
See https://github.com/pandas-dev/pandas/commit/7bfed01cb260c6d4a982f8de217d47b2f4396610

@Carreau is possible to configure meeseeksdev to include `-x` in the args at https://github.com/MeeseeksBox/MeeseeksDev/blob/77bac5daf0f9b2505bcdbe59dd0f1c75ceb36e64/meeseeksdev/meeseeksbox/commands.py#L434 (maybe there are downsides to that)?
It's not the `-x` from backporting manually that did the trick before, I think. It is just because we were directly cherry-picking, which preserves the commit author (although it change the commit committer). 

Here, the problem comes from going through a PR on github. Eg the commit in https://github.com/pandas-dev/pandas/pull/25663 still has correctly chris-b1 as the commit author (since the commit itself is just a cherry-pick). But when merging that PR, the PR author becomes the commit author of the squashed merged commit (and this is GitHub doing that, I think).

I opened https://github.com/MeeseeksBox/MeeseeksDev/issues/35 before as a possible solution.

Another solution might be that we don't squash backport PRs, but just merge them with a merge commit or with rebase and merge. But, then we always need to remember doing that for backport PRs, which is also error prone.
Ah thanks for the explanation.

I think manually adding the authors is best for now.

On Mon, Mar 11, 2019 at 10:37 AM Joris Van den Bossche <
notifications@github.com> wrote:

> It's not the -x from backporting manually that did the trick before, I
> think. It is just because we were directly cherry-picking, which preserves
> the commit author (although it change the commit committer).
>
> Here, the problem comes from going through a PR on github. Eg #25663
> <https://github.com/pandas-dev/pandas/pull/25663> still has correctly
> chris-b1 as the commit author (since the commit itself is just a
> cherry-pick). But when merging that PR, the PR author becomes the commit
> author of the squashed merged commit.
>
> I opened MeeseeksBox/MeeseeksDev#35
> <https://github.com/MeeseeksBox/MeeseeksDev/issues/35> before as a
> possible solution.
>
> Another solution might be that we don't squash backport PRs, but just
> merge them with a merge commit or with rebase and merge. But, then we
> always need to remember doing that for backport PRs, which is also error
> prone.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/pandas-dev/pandas/pull/25662#issuecomment-471591388>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/ABQHIl4wjBOcWS4kgHJPjyyXyX2nAoaTks5vVng1gaJpZM4bo3zu>
> .
>

Personally, I think that GitHub should automatically do the "Co-authored-by" thing when squashing a PR that has multiple commit authors .. but that's a change outside our reach.
# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=h1) Report
> Merging [#25662](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/c4fa3c93c7cee54249eaffc67d0e5a1e306e967c?src=pr&el=desc) will **decrease** coverage by `<.01%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/25662/graphs/tree.svg?width=650&token=eZ4WkYLtcO&height=150&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=tree)

```diff
@@            Coverage Diff             @@
##           master   #25662      +/-   ##
==========================================
- Coverage   91.29%   91.29%   -0.01%     
==========================================
  Files         173      173              
  Lines       52961    52961              
==========================================
- Hits        48350    48349       -1     
- Misses       4611     4612       +1
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `89.86% <ø> (ø)` | :arrow_up: |
| #single | `41.74% <ø> (ø)` | :arrow_up: |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/util/testing.py](https://codecov.io/gh/pandas-dev/pandas/pull/25662/diff?src=pr&el=tree#diff-cGFuZGFzL3V0aWwvdGVzdGluZy5weQ==) | `88.98% <0%> (-0.1%)` | :arrow_down: |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=footer). Last update [c4fa3c9...7ed570a](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=h1) Report
> Merging [#25662](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/c4fa3c93c7cee54249eaffc67d0e5a1e306e967c?src=pr&el=desc) will **decrease** coverage by `<.01%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/25662/graphs/tree.svg?width=650&token=eZ4WkYLtcO&height=150&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=tree)

```diff
@@            Coverage Diff             @@
##           master   #25662      +/-   ##
==========================================
- Coverage   91.29%   91.29%   -0.01%     
==========================================
  Files         173      173              
  Lines       52961    52961              
==========================================
- Hits        48350    48349       -1     
- Misses       4611     4612       +1
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `89.86% <ø> (ø)` | :arrow_up: |
| #single | `41.73% <ø> (ø)` | :arrow_up: |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/util/testing.py](https://codecov.io/gh/pandas-dev/pandas/pull/25662/diff?src=pr&el=tree#diff-cGFuZGFzL3V0aWwvdGVzdGluZy5weQ==) | `88.98% <0%> (-0.1%)` | :arrow_down: |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=footer). Last update [c4fa3c9...b6e394f](https://codecov.io/gh/pandas-dev/pandas/pull/25662?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

If you need commit right and access to heroku for the logs I'm happy to
give them to you. Let me know. I will try to see if we can do something
about authorship.

On Mon, Mar 11, 2019, 11:59 Tom Augspurger <notifications@github.com> wrote:

> *@TomAugspurger* commented on this pull request.
> ------------------------------
>
> In doc/source/whatsnew/v0.24.1.rst
> <https://github.com/pandas-dev/pandas/pull/25662#discussion_r264303430>:
>
> > @@ -82,4 +82,15 @@ Bug Fixes
>
>  Contributors
>
>  ~~~~~~~~~~~~
>
>
>
> -.. contributors:: v0.24.0..v0.24.1
>
> +.. Including the contributors hardcoded for this release, as backporting with
>
> +   MeeseeksDev loses the commit authors
>
> +
>
> +A total of 7 people contributed patches to this release. People with a “+” by their names contributed a patch for the first time.
>
> +
>
> +* Alex Buchkovsky
>
> +* Roman Yurchak
>
> +* h-vetinari
>
> +* jbrockmendel
>
> +* Jeremy Schendel
>
>
> I guess a whitespace issue here.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/pandas-dev/pandas/pull/25662#pullrequestreview-212926271>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AAUez2J8cK4i7NQ8c4Tdxuh0KMmiUussks5vVn1vgaJpZM4bo3zu>
> .
>