search

exercism / scala

Exercism exercises in Scala.
https://exercism.org/tracks/scala
MIT License
123 stars 131 forks source link

šŸ¤– Add authors and contributors to Practice Exercises #668

Closed ErikSchierboom closed 3 years ago

ErikSchierboom commented 3 years ago

If you got tagged in this PR, it is because you are being credited for work you've done in the past on Exercism here, and we want to ensure you don't miss out on the recognition you deserve šŸ™‚

With v3, we've introduced the idea of exercise authors and contributors. This information is stored in the exercises' .meta/config.json files (see the docs).

Concept Exercises, which are all new, already contain authors and contributors. Practice Exercises though are missing this information. In this PR, we attempt to populate the authors and contributors of Practice Exercises based on their commit history.

Maintainer TODO list

These are the things you, the maintainers, should do:

For clarity, authors should be the people who originally created the exercise on this track. Contributors should be people who have substantially contributed to that exercise. PRs for typos or multiple-exercise PRs do not automatically mean someone should be considered a contributor to that exercise. Those non-exercise-specific contributions will get recognition through Exercism's reputation system in v3.

If you find something needs updating, just push a new commit to this PR.

Automatic Merging

We will automatically merge this PR before we launch v3, but will give the maximum time we can to maintainers to review it first.

The rest of this issue explains how this PR has been generated. You do not need to read it.

Algorithm

We start out by looking at the current Practice Exercises. For each Practice Exercise, we'll look at the commit history of its files to see which commits touched that Practice Exercise. How renames are handled is discussed in the "Renames" section later in this document.

Any commit that we can associate with a Practice Exercise is used to determine authorship/contributorship. Here is how we assign authorship/contributorship:

Authors

  1. Find the Git commit author of the oldest commit linked to that Practice Exercise.
  2. Find the GitHub username for the Git commit author of that commit
  3. Add the GitHub username of the Git commit author to the authors key in the .meta/config.json file

Contributors

  1. Find the Git commit authors and any co-authors of all but the oldest commit linked to that Practice Exercise. If there is only one commit, there won't be any contributors.
  2. Exclude the Git commit author and any co-authors of the oldest commit from the list of Git commit authors (an author is not also a contributor)
  3. Find the GitHub usernames for the Git commit authors and any co-authors of those commits
  4. Add the GitHub usernames of the Git commit authors and any co-authors to the contributor key in the .meta/config.json file

We're using the GitHub GraphQL API to find the username of a commit author and any co-authors. In some cases though, a username cannot be found for a commit (e.g. due to the user account no longer existing), in which case we'll skip the commit.

Renames

There are a small number of Practice Exercises that might have been renamed at some point. You can ask Git to "follow" a file over its renames using git log --follow <file>, which will also return commits made before renames. Unfortunately, Git does not store renames, it just stores the contents of the renamed files and tries to guess if a file was renamed by looking at its contents. This can (and will) lead to false positives, where Git will think a file has been renamed whereas it hasn't. As we don't want to have incorrect authors/contributors for exercises, we're ignoring renames. The only exception to this are known exercise renames:

If you know of a rename of a Practice Exercise, please check to see if its authors and contributors are correctly set.

Exclusions

There are some commits that we skip over, which thus don't influence the authors/contributors list:

Tracking

https://github.com/exercism/v3-launch/issues/24

cc @abo64, @ajablonski, @Algiras, @astradamus, @austinlyons, @dmitryn, @ErikSchierboom, @Freshwood, @hrj, @jmtuley, @JPBetley, @kytrinyx, @magnusfurugard, @matteobaglini, @mlopes, @MohamedHajr, @nlochschmidt, @oujesky, @petertseng, @ppartarr, @rajeshpg, @ricemery, @RodrigoCSoares, @sathish316, @sgrif, @sjakobi, @skeskali, @stevejb71, @tqa236, @Trevoke, @yanick as you are referenced in this PR

ErikSchierboom commented 3 years ago

I should be removed as a contributor from all exercises. Note that I should still be listed as the author of the roman-numerals exercise (see https://github.com/exercism/scala/commit/889c1f59073ee5826647970a26b34782a8fd0790).

ErikSchierboom commented 3 years ago

This PR has been open for about 3 months. As having this PR merged is important to prepare this track for Exercism v3, we'll automatically merge this PR at the end of this week. If you need a little more time, convert this PR to a draft.