The attribution problem solution

Open
#102 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
git, python
Domain
tooling

Research direction

No repository file or test is identified. Start by reviewing the linked collection_migration pull request and the provided git log command, then determine whether this repository has a defined place for an attribution workflow; the issue does not specify a concrete change or completion condition.

Written by the indexing model from the issue text.

Description

https://blog.jaraco.com/skeleton/#history-is-forever suggests that the attribution problem is unsolvable but that's only partially true. While it's not possible to preserve the authorship of each line on squash, it's possible to retrieve the original authors before doing this and list them via the Co-Authored-By trailers. This would attribute that large commit to a whole lot of people. It's also possible to use tags instead of branches for archiving (but that's not what I'm going to talk about here).

Several years ago we were migrating a bunch of content out of ansible-core into separate repos. We made a script to rewrite stuff and make those repos according to scenarios.
I was also concerned about attribution and researched retrieving the authors. My patch didn't go in, because it was last-minute. But the PR is still around and could be helpful to others facing a similar problem: https://github.com/ansible-community/collection_migration/pull/497. Later on, I also suggested this solution to a Sphinx extension: https://github.com/sphinx-contrib/spelling/issues/60#issuecomment-665287993.

TL;DR here's how one can extract such a list:

$ git log '--pretty=format:%(trailers:key=Co-Authored-By,separator=%x0A)%x0A%an <%ae>%x0A%cn <%ce>' | sort | uniq

You can then stick everything into the commit message and have GitHub link the commit to all those people.

Dominant language
No language data
Stars
152
Forks
38
Avg merge
6h 27m
Merged PRs (30d)
4

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jaraco/skeleton

All issues in jaraco/skeleton

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.