Skip to content

fix: contributor crediting, and a tiered contributor section - #1180

Merged
edkerk merged 3 commits into
developfrom
chore/contributors
Oct 31, 2026
Merged

edkerk merged 3 commits into
developfrom
chore/contributors

Conversation

@edkerk

@edkerk edkerk commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Fixes contributor crediting, which has not worked since the July overhaul (#1049), and makes it easier to use and more visible.

The Add contributor workflow used peter-evans/create-pull-request, which is not in the repository's list of allowed actions. GitHub refused to start it: every run since then ended in startup_failure (200+ runs, one per issue comment), and no credit was added.

Crediting

  • /credit @user bug, research on any issue or pull request, one line per person. The older @all-contributors please add … is still understood.
  • The answer is added under the command: a link to the credit pull request, or what was wrong (unknown type, unknown user, already credited).
  • All credits go into one pull request, contributors/pending, against develop. It is rebuilt from develop on each command, so it never conflicts.
  • After a merge into develop, a comment lists ready-made /credit lines for the people involved who are not in the list yet: the authors of the closed issues and of the pull request. Nothing is credited until a maintainer replies with them.
  • When the credit pull request is merged, each person is thanked on the issue or pull request where they were credited.
  • Only actions/checkout is used, with gh and python3 from the runner.

Code

  • code/contributors.py (new) keeps .all-contributorsrc and the README section and replaces the all-contributors CLI, so Node is no longer needed. add, generate and check can be run locally; check fails on unknown types, a person listed twice, or a README that is out of date.
  • code/test/unit/test_contributors.py (new): 15 tests.

Contributor list (43 → 46)

Contributor Change
Hao Wang login Hao-Chalmers → haowang-bioinfo (account renamed)
Pierre-Etienne Cholley pecholley merged into pecholleyc
Nantia Leonidou (NantiaL) added, bug (#1178)
Carolina Chung (chechung) added, bug and research (#1142)
Runfeng Zhang (zrf492174) added, bug (#1072)
szkabel added, bug (#1021)
6 entries with an empty profile profile set to their GitHub page

README

  • The contributor section is in three tiers by number of contribution types: core team, curators and developers, and error reports and ideas.
  • A short paragraph says who is credited and links to CONTRIBUTING.

Docs

  • CONTRIBUTING.md, "Crediting contributors": the new flow, for contributors and for maintainers.
  • pull_request_template.md: the footer points to the new flow.

The workflow acts on comments and merges as it is on main, so it takes effect after the next release. It has not run on GitHub yet; the commands were tested locally against real issues and pull requests.

@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Model quality report

⚠️ 9 pre-existing finding(s), no regressions vs develop. Non-blocking. Gates: duplicate keys 0 ✅, growth 1.9 ✅, direction alarms 0 ✅.

Section Status
Model & network checks (24) ⚠️ 9 pre-existing
Model file & metabolic tasks (8) ✅ all pass
MEMOTE ✅ 63.8% (core subset)
Full report model_qc_summary.md

Pre-existing:

  • Reaction directions: warning: 70
  • Mass-imbalanced reactions: 65
  • Charge-imbalanced reactions: 145
  • Structure vs formula/charge inconsistencies: 51
  • Reactions flagged as MACAW duplicates: 338
  • Twin reactions with a missing or conflicting EC number: 52
  • Reactions flagged by MACAW dead-end test: 1380
  • Reactions split across compartments: 26
  • Unused genes: 2

✅ unchanged · ✨ improved vs develop · ⚠️ pre-existing, non-blocking · ❌ regression

Reaction directions: the alarm and the warning catch only directions that thermodynamics makes very unlikely. A reaction without an alarm or warning is not thereby shown to have the right reversibility.

Full workflow run · this comment is edited as results come in

@edkerk
edkerk force-pushed the chore/contributors branch from bb49ede to 65ae180 Compare October 30, 2026 16:19
The Add contributor workflow used peter-evans/create-pull-request, which the repository's allowed-actions list does not include, so every run since the July overhaul ended in startup_failure and no credit was added.

- code/contributors.py keeps .all-contributorsrc and the README table and checks them; no Node needed.
- `/credit @user bug, research` (one line per person) adds to one rolling pull request, contributors/pending, rebuilt from develop each time. The answer is added under the command, with errors for unknown types or users.
- After a merge into develop, uncredited issue and PR authors are proposed as ready-made /credit lines for a maintainer to confirm.
- When the credit pull request is merged, each person is thanked where they were credited.
- Contributor list: Hao Wang's renamed login, one entry for Pierre-Etienne Cholley, four missing reporters, GitHub profile links for entries without one.
- README: contributor section in three tiers (core team, curators and developers, error reports and ideas) by number of contribution types, then by name.
- CONTRIBUTING and the PR template explain the flow.
@edkerk
edkerk force-pushed the chore/contributors branch from 65ae180 to ec3f7b3 Compare October 31, 2026 17:09
edkerk and others added 2 commits October 31, 2026 20:43
# Conflicts:
#	code/test/unit/conftest.py
#	data/testResults/model_qc_comment.md
#	data/testResults/model_qc_summary.md
@edkerk
edkerk merged commit dc31f46 into develop Oct 31, 2026
@edkerk
edkerk deleted the chore/contributors branch October 31, 2026 19:57
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.

1 participant