docs: add posting issues guidance [skip tests] by mayankansys · Pull Request #5089 · ansys/pyfluent

mayankansys · 2026-04-29T10:18:10Z

Context

Issues originating in the Fluent solver/API/server were being filed in the PyFluent repository, creating unnecessary triage overhead for maintainers. No guidance existed to redirect users to the appropriate support channels.

Change Summary

Expanded "Post issues" section in contributing_contents.rst with a scoping note and support channel links.
Updated root CONTRIBUTING.md with the same guidance, visible directly on GitHub.
Added a scoping note to faqs.rst "How do you get help" section.
Created .github/ISSUE_TEMPLATE/config.yml to show Ansys Developer Forum and Ansys Support links before a user files an issue.

Impact

Maintainers: Faster triage with the new fluent-side label and early user redirection.
Users: Clear guidance on where to report Fluent solver/API issues before filing.

codacy-production · 2026-04-29T10:20:02Z

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer}
_{TIP This summary will be updated as you push new changes.}

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds clearer guidance to route Fluent solver/API/server issues to the proper Ansys support channels, reducing incorrect issue filings in the PyFluent repo.

Changes:

Add scoping notes + support links in docs and GitHub-facing CONTRIBUTING guidance.
Add a GitHub issue template config with “contact links” to redirect users before filing.
Add a dedicated fluent-side label for triage.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
doc/source/getting_started/faqs.rst	Adds a note clarifying what belongs in PyFluent issues vs Fluent-side support channels.
doc/source/contributing/contributing_contents.rst	Expands “Post issues” guidance with scoping + support channel pointers.
doc/changelog.d/5089.documentation.md	Adds a changelog entry for the documentation update.
CONTRIBUTING.md	Adds GitHub-visible note describing where to file Fluent-side vs PyFluent-side issues.
.github/labels.yml	Introduces `fluent-side` label to support triage.
.github/ISSUE_TEMPLATE/config.yml	Adds contact links (Developer Forum, Support) shown before filing issues.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

prmukherj · 2026-04-29T10:25:37Z

In general I think it is good to have a message in contributing section, but one note should be there at higher level, user guide? or ReadMe? Not sure, but overall looks good.

prmukherj · 2026-04-29T10:36:56Z

In general I think it is good to have a message in contributing section, but one note should be there at higher level, user guide? or ReadMe? Not sure, but overall looks good.

Actually there is similar way we can tag this info in the github issues page only. I think that is a good idea. @mayankansys, does your config file already does it?

prmukherj · 2026-04-29T13:02:59Z

If it is an issue with Fluent including it's APIs, post it in the Ansys support just like any other Fluent issues or go to dev forum.

Just re-phrase this sentence and put it.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mayankansys · 2026-04-30T06:00:36Z

In general I think it is good to have a message in contributing section, but one note should be there at higher level, user guide? or ReadMe? Not sure, but overall looks good.

Actually there is similar way we can tag this info in the github issues page only. I think that is a good idea. @mayankansys, does your config file already does it?

@prmukherj Yes, the config.yml supports contact_links which show external links (like Ansys support / dev forum) directly on the GitHub "New Issue" page.

mayankansys · 2026-04-30T06:03:07Z

In general I think it is good to have a message in contributing section, but one note should be there at higher level, user guide? or ReadMe? Not sure, but overall looks good.

@prmukherj That's a great idea. But should be provide the link at the higher level or at the issue creation point or both ?

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…/ansys/pyfluent into docs/add_posting_issues_guidance

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

seanpearsonuk · 2026-05-01T08:10:22Z

I think it's good enough as it stands. No need to split hairs further.

prmukherj · 2026-05-01T08:21:18Z

Finally as comment of the tasks that we will be closing after this PR is merged can have a message like:

This is a problem in Fluent(or its API). Please report it on the Ansys Developer Forum or through the usual support channel.

cc. @seanpearsonuk, @mkundu1, @mayankansys, @hpohekar

seanpearsonuk · 2026-05-01T09:40:32Z

Finally as comment of the tasks that we will be closing after this PR is merged can have a message like:

This is a problem in Fluent(or its API). Please report it on the Ansys Developer Forum or through the usual support channel.

cc. @seanpearsonuk, @mkundu1, @mayankansys, @hpohekar

Yeah, just refer to it as a Fluent issue and direct them in the way you say. Make sure to link to the place in the doc so that the message can be kept brief.

…ip tests] (#5109) Updated with respect to the Fluent issue posting guidelines. Please refer this for detailed updates: #5089 --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

docs: add posting issues guidance

08c7bb2

Copilot AI review requested due to automatic review settings April 29, 2026 10:18

mayankansys requested review from hpohekar, mkundu1, prmukherj and seanpearsonuk as code owners April 29, 2026 10:18

github-actions Bot added documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc) CI/CD labels Apr 29, 2026

chore: adding changelog file 5089.documentation.md [dependabot-skip]

a3647a9

mayankansys linked an issue Apr 29, 2026 that may be closed by this pull request

Posting issues guidance #4542

Closed

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread doc/source/contributing/contributing_contents.rst Outdated

Comment thread CONTRIBUTING.md Outdated

Comment thread doc/changelog.d/5089.documentation.md

Comment thread .github/ISSUE_TEMPLATE/config.yml

prmukherj reviewed Apr 29, 2026

View reviewed changes

Comment thread .github/labels.yml Outdated

prmukherj reviewed Apr 29, 2026

View reviewed changes

Comment thread doc/source/contributing/contributing_contents.rst Outdated

prmukherj reviewed Apr 29, 2026

View reviewed changes

Comment thread .github/ISSUE_TEMPLATE/config.yml

Update doc/source/contributing/contributing_contents.rst

364ca23

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 30, 2026 04:40

Copilot started reviewing on behalf of mayankansys April 30, 2026 04:40 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread CONTRIBUTING.md Outdated

mayankansys marked this pull request as draft April 30, 2026 05:01

suggested chnages

76e9677

prmukherj reviewed Apr 30, 2026

View reviewed changes

Comment thread doc/source/getting_started/faqs.rst Outdated

Merge branch 'main' into docs/add_posting_issues_guidance

aab6924

mayankansys marked this pull request as ready for review April 30, 2026 15:43

Copilot AI review requested due to automatic review settings April 30, 2026 15:43

Copilot started reviewing on behalf of mayankansys April 30, 2026 15:44 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread doc/source/getting_started/faqs.rst Outdated

mayankansys added 3 commits April 30, 2026 21:30

updated

0b88701

Merge branch 'docs/add_posting_issues_guidance' of https://github.com…

b312e28

…/ansys/pyfluent into docs/add_posting_issues_guidance

docs: remove scope note from FAQs

6bc4cba

Copilot AI review requested due to automatic review settings April 30, 2026 16:08

Copilot started reviewing on behalf of mayankansys April 30, 2026 16:09 View session

Merge branch 'main' into docs/add_posting_issues_guidance

0eb0299

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread doc/source/contributing/contributing_contents.rst

prmukherj reviewed Apr 30, 2026

View reviewed changes

Comment thread CONTRIBUTING.md

prmukherj reviewed Apr 30, 2026

View reviewed changes

Comment thread doc/source/contributing/contributing_contents.rst

seanpearsonuk approved these changes May 1, 2026

View reviewed changes

prmukherj approved these changes May 1, 2026

View reviewed changes

prmukherj merged commit e5cb160 into main May 1, 2026
110 of 113 checks passed

prmukherj deleted the docs/add_posting_issues_guidance branch May 1, 2026 10:47

prmukherj mentioned this pull request May 5, 2026

docs: Updated with respect to the Fluent issue posting guidelines [skip tests] #5109

Merged

Conversation

mayankansys commented Apr 29, 2026

Context

Change Summary

Impact

Uh oh!

codacy-production Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Up to standards ✅

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

prmukherj commented Apr 29, 2026

Uh oh!

Uh oh!

prmukherj commented Apr 29, 2026

Uh oh!

prmukherj commented Apr 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

mayankansys commented Apr 30, 2026

Uh oh!

mayankansys commented Apr 30, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seanpearsonuk commented May 1, 2026

Uh oh!

prmukherj commented May 1, 2026

Uh oh!

seanpearsonuk commented May 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codacy-production Bot commented Apr 29, 2026 •

edited

Loading

seanpearsonuk commented May 1, 2026 •

edited

Loading