ansys / .github Goto Github PK

From private conversations

Hi everyone, Luckily we started seeing some people at ACE create Example issues for PyDPF lately, yet the question of the IP (and size) of the result file the example is based on is always a problem. My question is: would it be possible for the section in the template where we ask people to drag and drop their result file, to have a check box reminding them to check for IP and confirm there is no private data, before actually activating the drop zone?

Description of the modifications

The links to the Ansys Developer Portal, https://developer.ansys.com/, in the documentation don't work. Presumably the site has moved.

Thanks

Useful links and references

No response

📝 Description of the feature

If you could create a “Syntax Request” label for new issues, it may help people who need help using the API but who feel that opening an issue as a bug is a misclassification. Just thinking aloud. If you think I should open a bug every time I have a question on syntax, I can keep doing so.

💡 Steps for implementing the feature

Create “Syntax Request” label (or something to that effect)

🔗 Useful links and references

No response

🐞 Problem
When a user or a dev requests a new feature, the references section may not contain any references at all. Thus, it appears completely empty with a single "dot".

On top of that, the emojis are not showing up and the headers font size is, in my opinion, quite big. When reading the issue, your eyes go directly into these big size headers and get annoyed by changing to a small font then.

Also, emojis are not being displayed.

We should create an Examples template that allow users to provide the necessary data to post an example for the repository. That way, people will not have to worry about adapting to a repos technicalities, and the examples won't get lost.

Provide a guided template for adding description, uploading data etc.

Description to be improved.

"Description of the bug" field in bug template should tell user to use text, and not screenshots. This will be much more useful for looking into the issue - I find it surprising to see a lot of screenshots being included in the issues.

🐞 Problem

The .github/ repository was devised to unify common files across organization repositories. The current repository is used as a fallback for any PyAnsys repo which does not have a .github folder. However, only special files are considered by this repo, including:

• The .github/ISSUE_TEMPLATE dir.
• The CODE_OF_CONDUCT.md and CONTRIBUTING.md files.

These are some of all the allowed files in the .github/ repo.

💡 Solution

There are various tasks here:

• Create a generic bug template
• Create a generic feature template

Before implementing this, let us use the https://github.com/pyansys-testing/ as a sandbox. I want to make sure everything works as expected before performing any modifications here, as they will affect all projects in the organization.

📝 Description of the example

Demo

📁 Files needed for running the example

demo.txt

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

2023R2

🐍 Which Python version are you using?

3.7

📦 Installed packages

``blablabla``

📝 Description of the feature

You can add an open source library or plug-in that displays 3D models and 3D simulation results on the webpage, and it is more convenient to display the simulation results in some blogs (Hexo, WordPress). It is convenient to drag and drop with the mouse, select the corresponding curve, and view the corresponding value. The result will not be a simple picture, but an information display with simple interaction. The front-end technology should be used to make the display more beautiful. This is also convenient for making models in web pages, using cloud simulation services, and displaying simulation results.

💡 Steps for implementing the feature

No response

🔗 Useful links and references

No response

🐞 Problem

The current feature forms have a mandatory "How to Implement" section. This prevents users who ask for new features but have no idea how to implement those from opening the issue.

💡 Solution

This section should be optional.

Let’s implement some minimal style checking, even for a non-code repo like this.

Let’s have at least a yml checker and a code spell up and running before any other PRs.

In bug submission template we could request which ANSYS version(s) the user tried.