[docs/CI] contribution guide update, adding a context item on issue template, update issue-link reminder by yiyixuxu · Pull Request #15179 · huggingface/diffusers

yiyixuxu · 2026-11-04T09:08:45Z

this PR:

1. Ask for "Context" in the issue templates

Adding a new optional Context field on the bug report: what project were you working on when you run into this issue? The motivation is to help us prioritize our work. i.e. we want to focus more on issues users run into when they building an app on top of Diffusers, than the theoretical ones.

2. Update on the issue-link reminder bot

I notice a lot of times model authors don't check the author box and end up getting the bot reminder, see an example #15155 (comment). So in this PR I added instructions to the reminder for that scenario (tell them to check the box and the reminder no longer applies etc). Also updated the wording of the author box a little, since the teams/contributors we work with do not necessarily consider themselves "model authors", it is now Are you the author (or part of the team we work with) of the model/pipeline this PR relates to?.

The other thing that happens a lot: the contributor opens an issue themselves and link to the PR after seeing the reminder. we should not count these as linked since they are not existing issues and we did not have a discussion first, so these PR stays on the Slack rescue route despite the fact that now linked to an issue.

3. Contribution guide rewrite

I went over the contribution guide and updated as much as I can for contents that're outdated:

remove the forum, we are using GitHub Discussions now
remove the section on contributing a community pipeline, replaced with publishing a modular pipeline/model on the Hub as remote code
make sure we always ask them to discuss first (the guide used to say "feel free to open a PR directly" in a few places). "How to write a good PR" now starts from an issue (issue → discussion → PR) - we don't enforce the discussion-first rule, e.g. if the PR comes for an issue we still review it, but we prefer to have a discussion first and so should say so in our contribution guide
moved some general rules that only lived in the AI section (fix patterns not one-offs, write the description for the reviewer, run self-review) into the general contribution guide as well, I think these applies to all contributors. the self-review part you need a AI but we highly recommend it as part of the contribution workflow; the AI section keeps only what is most relevant to agents
make it clear that the workflow for community to contribute a new model/pipeline is to have a remote hub node first instead of directly open a PR

Applies to both the fixes-issue label and the issue-link reminder. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

…ms, clearer reminder bot - Contribution guide: overview reordered by time commitment (Discussions replaces the forum, community pipelines replaced by publishing on the Hub, MVP issues and library integration as their own items); "How to write a good PR" now starts from an issue and folds in the general rules from the AI section; "How to write a good issue" asks for context and links the reporting guide. - Issue forms: optional Context field on the bug report, project context in the feature request's additional context, reporting guide linked from the reproduction field. - PR template: generic author/team checkbox wording. - Reminder bot: tells authors how to clear it (link an existing issue, tick the author box, or wait for `no-issue-needed`), and that an issue opened after the PR does not count. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

HuggingFaceDocBuilderDev · 2026-11-04T09:14:05Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Pages changed in this PR:

en/conceptual/contribution

yiyixuxu · 2026-11-04T09:14:23Z

 You can contribute in many ways ranging from answering questions on issues and discussions to adding new diffusion models to the core library.

-In the following, we give an overview of different ways to contribute, ranked by difficulty in ascending order. All of them are valuable to the community.
+In the following, we give an overview of different ways to contribute, ranked by the time commitment required, in ascending order. All of them are valuable to the community.


change "difficulty" to "time commitment required" e.g. I don't think creating an issue is necessarily more difficult than fixing it, not anymore

yiyixuxu · 2026-11-04T09:14:57Z

-In the following, we give an overview of different ways to contribute, ranked by difficulty in ascending order. All of them are valuable to the community.
+In the following, we give an overview of different ways to contribute, ranked by the time commitment required, in ascending order. All of them are valuable to the community.

-* 1. Asking and answering questions on [the Diffusers discussion forum](https://discuss.huggingface.co/c/discussion-related-to-httpsgithubcomhuggingfacediffusers) or on [Discord](https://discord.gg/G7tWnz98XR).


remove the mention of the forum since we are not actively using it anymore

sayakpaul

Excellent improvements!

sayakpaul · 2026-11-05T08:54:16Z

+    attributes:
+      label: Context
+      description: What were you working on when you run into this issue? A little bit of context helps us understand the impact and prioritize. A link to the project is great if you have one, not required.
+      placeholder: "Working on X [link], run into this issue when ..."


This is a very nice addition!

stevhliu

thanks for updating and improving!

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

The forum category has not been used in a long time; the contribution guide moved to GitHub Discussions in #15179. This catches the three mentions left: the PR template checkbox, the translation issue template, and the controlling generation guide. Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>

yiyixuxu and others added 2 commits October 21, 2026 09:30

Do not count issues the PR author opened after the PR as linked

ca94c2d

Applies to both the fixes-issue label and the issue-link reminder. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions Bot added documentation Improvements or additions to documentation CI size/L PR with diff > 200 LOC labels Nov 4, 2026

yiyixuxu commented Nov 4, 2026

View reviewed changes

Comment thread .github/ISSUE_TEMPLATE/bug-report.yml Resolved

Apply suggestion from @yiyixuxu

2e3cd6e

yiyixuxu commented Nov 4, 2026

View reviewed changes

Comment thread .github/ISSUE_TEMPLATE/bug-report.yml Resolved

Apply suggestion from @yiyixuxu

ba839af

yiyixuxu commented Nov 4, 2026

View reviewed changes

yiyixuxu requested review from sayakpaul and stevhliu November 4, 2026 09:16

sayakpaul approved these changes Nov 5, 2026

View reviewed changes

stevhliu approved these changes Nov 5, 2026

View reviewed changes

yiyixuxu and others added 3 commits November 6, 2026 08:08

Apply batched suggestions from code review

3167607

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

Update docs/source/en/conceptual/contribution.md

fab4ed6

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

Merge branch 'main' into linked-issue-self-opened

b45f75e

yiyixuxu merged commit 0fccef1 into main Nov 6, 2026
14 of 15 checks passed

yiyixuxu deleted the linked-issue-self-opened branch November 6, 2026 18:42

Navigation Menu

Repository navigation

[docs/CI] contribution guide update, adding a context item on issue template, update issue-link reminder - #15179

[docs/CI] contribution guide update, adding a context item on issue template, update issue-link reminder#15179
yiyixuxu merged 7 commits into
mainfrom
linked-issue-self-opened

yiyixuxu commented Nov 4, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

HuggingFaceDocBuilderDev commented Nov 4, 2026

Uh oh!

yiyixuxu Nov 4, 2026

Uh oh!

yiyixuxu Nov 4, 2026

Uh oh!

sayakpaul left a comment

Uh oh!

sayakpaul Nov 5, 2026

Uh oh!

stevhliu left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

yiyixuxu commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HuggingFaceDocBuilderDev commented Nov 4, 2026

Uh oh!

yiyixuxu Nov 4, 2026

Choose a reason for hiding this comment

Uh oh!

yiyixuxu Nov 4, 2026

Choose a reason for hiding this comment

Uh oh!

sayakpaul left a comment

Choose a reason for hiding this comment

Uh oh!

sayakpaul Nov 5, 2026

Choose a reason for hiding this comment

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

yiyixuxu commented Nov 4, 2026 •

edited

Loading