Skip to content

feat: overhaul contributor tracking (workflow, list refresh, six badge types)#1049

Merged
edkerk merged 6 commits into
developfrom
feat/contributor-action
Jul 11, 2026
Merged

feat: overhaul contributor tracking (workflow, list refresh, six badge types)#1049
edkerk merged 6 commits into
developfrom
feat/contributor-action

Conversation

@edkerk

@edkerk edkerk commented Jul 11, 2026

Copy link
Copy Markdown
Member

Main improvements in this PR:

This overhauls how contributors are tracked (addresses #414) and refreshes the list, which had not been updated since November 2023.

Adding contributors (#414). The all-contributors App can only open pull requests against the default branch main (app#243, open since 2019); credits added there are lost when main is rebuilt from develop at release.

  • Add .github/workflows/add-contributor.yml. A maintainer comments @all-contributors please add @user for bug, code on any issue or pull request; the workflow runs the all-contributors CLI and opens the pull request against develop. Runs on the default GITHUB_TOKEN, write-access only.
  • Document the flow in .github/CONTRIBUTING.md and add a reminder to the pull request template.

Refreshed contributor list.

  • Add 12 contributors active since the list was last updated, and restore Jiahao Luo, who was shown in the README but missing from .all-contributorsrc (a main/develop divergence artifact). Credit recent work by edkerk, Devlin-Moyer and johan-gson. Total 31 → 43.
  • Consolidate the 16 contribution types in use to six (bug, research, code, review, doc, ideas), combining overlapping credits so the grid is readable.
  • Show 10 contributors per row at a smaller image size (80 → 64 px). Regenerating the grid also repairs 105 corrupted emoji (stored as byte 0x1A) and drops a duplicate Christoff1993 cell.

Housekeeping. Remove the retired Gitter references (README badge, CONTRIBUTING, .standard-GEM.md).

Two one-time repository settings (admin) are needed for the workflow to take over from the App: uninstall the "All Contributors" App, and enable Settings → Actions → General → "Allow GitHub Actions to create and approve pull requests".

I hereby confirm that I have:

  • Tested my code on my own computer for running the model
  • Selected develop as a target branch
  • Any removed reactions and metabolites have been moved to the corresponding deprecated identifier lists

)

The all-contributors GitHub App can only open pull requests against the
default branch (main); see all-contributors/app#243. Additions on main
are overwritten when main is rebuilt from develop at release, so credited
contributors were lost.

Replace the App with a self-hosted workflow that reacts to the same
"@all-contributors please add @user for <types>" comment, runs the
all-contributors CLI, and opens the pull request against develop instead.
Update CONTRIBUTING.md to describe the new flow.
@github-actions

github-actions Bot commented Jul 11, 2026

Copy link
Copy Markdown

This PR has been automatically tested with GH Actions. Here are the results of the quality-control tests:

MACAW: dead-end and duplicate tests

Starting dead-end test...
 - Found 1384 dead-end metabolites.
 - Found 1141 reactions incapable of sustaining steady-state fluxes in either direction due to these dead-ends.
 - Found 1369 reversible reactions that can only carry steady-state fluxes in a single direction due to dead-ends.
Starting duplicate test...
 - Skipping redox duplicates because no redox_pairs and/or proton_ids were provided.
 - Found 377 reactions that were some type of duplicate:
   - 0 were completely identical to at least one other reaction.
   - 13 involve the same metabolites but go in the opposite direction or have the opposite reversibility as at least one other reaction.
   - 377 involve the same metabolites but with different coefficients as at least one other reaction.

Mass and charge balance

Unbalanced reactions (excluding boundary and biomass): 277 (87 mass, 240 charge)

More detailed output is committed to data/testResults/ (macaw_results.csv and balance_results.csv).

Note: In the case of multiple test runs, this post will be edited.

@edkerk edkerk changed the title Add contributors on develop via a comment-triggered workflow Add contributor workflow targeting develop, and tidy contributing docs Jul 11, 2026
Add a "Crediting contributors" section to CONTRIBUTING.md that explains the
comment-triggered workflow, and a maintainer reminder in the pull request
template so new contributors get credited after merge.

Remove the retired Gitter references from the README badge, CONTRIBUTING,
and .standard-GEM.md.
@edkerk edkerk changed the title Add contributor workflow targeting develop, and tidy contributing docs feat: add contributor workflow targeting develop Jul 11, 2026
@edkerk edkerk added this to the 2.0.1 milestone Jul 11, 2026
- Add 12 contributors active since Nov 2023 and restore Jiahao Luo
  (previously README-only) to .all-contributorsrc; credit recent work by
  edkerk, Devlin-Moyer and johan-gson.
- Consolidate the 16 contribution types in use to six (bug, research,
  code, review, doc, ideas), combining overlapping credits.
- Show 10 contributors per row at a smaller image size (80 -> 64 px); the
  regenerated grid also repairs 105 corrupted emoji and drops a duplicate
  Christoff1993 cell.
- Document the six types in CONTRIBUTING.md.
@edkerk edkerk changed the title feat: add contributor workflow targeting develop feat: overhaul contributor tracking (workflow, list refresh, six badge types) Jul 11, 2026
@edkerk
edkerk merged commit 5f3a0e9 into develop Jul 11, 2026
2 of 6 checks passed
@edkerk
edkerk deleted the feat/contributor-action branch July 11, 2026 20:55
@mihai-sysbio

Copy link
Copy Markdown
Member

Well done @edkerk 🙌🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants