Zero external issues and zero Discussions: post and pin the who's-using-this thread

Aperta
  • Qualcosa non va?
#126 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
github, python
Ambito
documentation

Direzione di ricerca

Read scripts/issue-drafts/_DISCUSSION_who_is_using_this.md and locate the Maturity block and existing Discussions link in README.md. Post and pin the drafted thread, add a direct link near the Maturity block, and contact the named external contributors. Done means the README links the thread and at least one non-maintainer has posted an issue or Discussion reply; this depends on external participation.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation help wanted
Status (2026-11-04)

The title and "What's wrong" below describe 2026-08-20 and are partly out of date:

  • Steps 1 and 2 are mostly done: Discussion #158 ("Are you using PhilanthroPy?") is posted and README.md links it directly, but it is not pinned (the repository has no pinned Discussions as of 2026-11-04). Pinning it is the one mechanical step left. #188 ("What tripped you up?") was added on 2026-09-06. Both shell checks under "Done when" now pass. The draft file the table points at, scripts/issue-drafts/_DISCUSSION_who_is_using_this.md, no longer exists because it was posted.
  • Step 3 is done (outreach on 2026-09-06, logged on #127).
  • What is left is the part no shell check can assert. External issues: 2 (#129 by slegarraga, #357 by Jahnavi-HJ), target 3. External Discussion replies: 1 (#188), target 2. #158 has 0 replies.

This issue closes when both targets are met by people other than the maintainer. Step 4 still applies: nothing seeded.

What's wrong

Every issue ever filed against this repository is maintainer-authored, and there are zero
Discussions even though Discussions is enabled.

That is one specific line on the JOSS reviewer checklist:

Collaborative effort: Does the project show evidence of community engagement such as
contributions from multiple developers, issues/discussions from external users, or community
influence on the development described in the paper?

Half of that item is already strong: 17 merged external pull requests from 5 external
contributors. The other half reads as absent. A reviewer sees an issue tracker where every entry
is the maintainer talking to themselves.

There is also no instrument by which a user could signal existence. The library makes no network
calls and has no telemetry, deliberately, and that is worth keeping. So a pinned Discussion is the
only available channel.

Where
File Locate with
the drafted thread body, written and never posted ls scripts/issue-drafts/_DISCUSSION_who_is_using_this.md
the existing generic Discussions link, near the bottom grep -in 'discussion' README.md
the Maturity block the direct link should sit near grep -n -i 'maturity' README.md
What to change
  1. Post the drafted Discussion at scripts/issue-drafts/_DISCUSSION_who_is_using_this.md and
    pin it. Read it first: it was drafted before the paper landed and may want a sentence about
    the JOSS submission.
  2. Link the thread directly from README.md. There is already a generic
    /discussions link, but it sits in the contributing section near the bottom of the file, where
    a prospective user does not reach it. Add a direct link to the pinned thread near the Maturity
    block.
  3. Message the five external contributors (@slegarraga, @shubhrai23, @fuleinist, @BortnikMaxim,
    @AsavariCharati) and ask whether they hit anything worth filing. They touched the docs and the
    test suite; they will have noticed something. One issue from a contributor who is not you costs
    one message and changes the shape of the tracker.
  4. Do not manufacture the signal. Do not file issues from a second account, and do not seed the
    Discussion with fake replies. A reviewer can read timestamps, and the whole point of this
    project's honesty passes is that the record survives inspection.
Tests to add or extend

None. Nothing here touches code.

Done when
# Exits 0 only once at least one Discussion exists.
R=PhilanthroPy-Project/PhilanthroPy
test "$(gh api graphql -f query="{repository(owner:\"${R%%/*}\",name:\"${R##*/}\"){discussions{totalCount}}}" \
  --jq '.data.repository.discussions.totalCount')" -gt 0

# And that the README links the thread itself, not just the generic tab.
grep -qE 'discussions/[0-9]+' README.md

Plus, and this is the part that actually matters and no shell check can assert: at least one issue
or Discussion reply authored by somebody who is not the maintainer.

Partly self-healing, but not in time

JOSS reviewers are instructed to file issues directly against the submitted repository under their
own accounts, so this gap closes during review. It does not help at triage, which is when the
checklist is first read.

Lingua principale
Python
Stelle
11
Fork
23
Merge medio
1g 6h
PR unite (30g)
35

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PhilanthroPy-Project/PhilanthroPy

Tutte le issue di PhilanthroPy-Project/PhilanthroPy

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.