From 6b22da5aadec46af37e4c6f6248f0ecf35d64bd1 Mon Sep 17 00:00:00 2001 From: Devin Date: Tue, 21 May 2024 18:28:08 +0200 Subject: [PATCH 1/4] DOCS: Update readme Minor changes to README.md Added a note about the sematic PR convention. --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a4b5fbc0fed..c7a185ec323 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,14 @@ PyAEDT is a Python library that interacts directly with the API for Ansys Electronics Desktop (AEDT) to make scripting simpler. The architecture for PyAEDT can be reused for all AEDT 3D products (HFSS, Icepak, Maxwell 3D, -and Q3D Extractor), 2D tools, and Ansys Mechanical. PyAEDT also provides +and Q3D Extractor), 2D tools, and Ansys Mechanical inside AEDT. PyAEDT also provides support for circuit tools like Nexxim and system simulation tools like Twin Builder. Finally, PyAEDT provides scripting capabilities in Ansys layout -tools like HFSS 3D Layout and EDB. The PyAEDT class and method structures +tools like HFSS 3D Layout. The Ansys Electronics Database +([EDB](https://edb.docs.pyansys.com/version/stable/)) is included +with PyAEDT as a dependency and is recommended for any automated manipulation and +setup of layout data for PCBs, electronic packages and integrated circuits. +The PyAEDT class and method structures simplify operation while reusing information as much as possible across the API. @@ -130,6 +134,28 @@ To reach the project support team, email [pyansys.core@ansys.com](mailto:pyansys To run PyAEDT, you must have a local licenced copy of AEDT. PyAEDT supports AEDT versions 2022 R1 or newer. +## Contributing + +See the [PyAnsys develoeprs guide](https://dev.docs.pyansys.com) for detailed information about contributing to the PyAnsys project. + +Note that PyAEDT uses sematic naming for pull requests (PR). This convention greatly simplifies +the review process by providing meaningful information in the PR title. The +following prefixes should be used for pull requests: + +- "BUILD" +- "CHORE" +- "CI" +- "DOCS" +- "FEAT" +- "FIX" +- "PERF" +- "REFACTOR" +- "REVERT" +- "STYLE" +- "TEST" + + + ## Student version PyAEDT supports AEDT Student versions 2022 R1 and later. For more information, see the From 012329e2d46ec60acc55e5558289db43af52e2f8 Mon Sep 17 00:00:00 2001 From: Massimo Capodiferro <77293250+maxcapodi78@users.noreply.github.com> Date: Tue, 21 May 2024 21:29:24 +0200 Subject: [PATCH 2/4] Update README.md Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com> --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c7a185ec323..87469d1307e 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,8 @@ PyAEDT supports AEDT versions 2022 R1 or newer. See the [PyAnsys develoeprs guide](https://dev.docs.pyansys.com) for detailed information about contributing to the PyAnsys project. -Note that PyAEDT uses sematic naming for pull requests (PR). This convention greatly simplifies +Note that PyAEDT uses semantic naming for pull requests (PR). This convention greatly simplifies + the review process by providing meaningful information in the PR title. The following prefixes should be used for pull requests: From 1f293e170ded90d10839f39bf843e4b4a43f4ec0 Mon Sep 17 00:00:00 2001 From: Devin <38879940+dcrawforAtAnsys@users.noreply.github.com> Date: Wed, 22 May 2024 08:33:18 +0200 Subject: [PATCH 3/4] Apply suggestions from code review Add suggestions from @pipkat Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 87469d1307e..ce49f868070 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,8 @@ Twin Builder. Finally, PyAEDT provides scripting capabilities in Ansys layout tools like HFSS 3D Layout. The Ansys Electronics Database ([EDB](https://edb.docs.pyansys.com/version/stable/)) is included with PyAEDT as a dependency and is recommended for any automated manipulation and -setup of layout data for PCBs, electronic packages and integrated circuits. +setup of layout data for PCBs, electronic packages, and integrated circuits. + The PyAEDT class and method structures simplify operation while reusing information as much as possible across the API. @@ -136,7 +137,8 @@ PyAEDT supports AEDT versions 2022 R1 or newer. ## Contributing -See the [PyAnsys develoeprs guide](https://dev.docs.pyansys.com) for detailed information about contributing to the PyAnsys project. +For comprehensive information on contributing to the PyAnsys project, see the [PyAnsys developer's guide](https://dev.docs.pyansys.com). + Note that PyAEDT uses semantic naming for pull requests (PR). This convention greatly simplifies From a1fb718e485cab9ff82400ece0a9b62b3cb4aa4e Mon Sep 17 00:00:00 2001 From: Devin Date: Wed, 22 May 2024 08:36:51 +0200 Subject: [PATCH 4/4] DOCS: Update readme Add hyperlink to commit-style. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ce49f868070..8cee89d3b48 100644 --- a/README.md +++ b/README.md @@ -140,10 +140,12 @@ PyAEDT supports AEDT versions 2022 R1 or newer. For comprehensive information on contributing to the PyAnsys project, see the [PyAnsys developer's guide](https://dev.docs.pyansys.com). -Note that PyAEDT uses semantic naming for pull requests (PR). This convention greatly simplifies - -the review process by providing meaningful information in the PR title. The -following prefixes should be used for pull requests: +Note that PyAEDT uses semantic naming for pull requests (PR). This convention +greatly simplifies the review process by providing meaningful +information in the PR title. The +following +[prefixes](https://github.com/ansys/actions/blob/main/commit-style/action.yml) +should be used for pull request name: - "BUILD" - "CHORE" @@ -158,7 +160,6 @@ following prefixes should be used for pull requests: - "TEST" - ## Student version PyAEDT supports AEDT Student versions 2022 R1 and later. For more information, see the