ansys / ansys/pyansys-dev-guide

Dev guide update

Open
#613 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
No language data
Stars
41
Forks
9
Avg merge
11h 24m
Merged PRs (30d)
12

Description

On top of being a central place to retrieve information on how to develop and maintain a PyAnsys project, the dev guide can also be used through AI tooling, e.g. the us of copilot-instructions.md presented recently by @Revathyvenugopal162

Following that discussion, we could have a look at the repo and see what should be added / removed / updated.

I plan to do that while performing the OSS's technical review for a pyaedt toolkit. Any help is welcome !

Here is a list (to be updated...):

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing PyAnsys developer guide repository and the discussion about copilot-instructions.md. Inventory what should be added, removed, or updated, then confirm the guide reflects the agreed development and maintenance guidance and supports the intended AI-tooling use cases.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.