From a1af216099837ce8831c6bc1a307f18fbbea72b7 Mon Sep 17 00:00:00 2001 From: PyAnsys Automation bot <214123248+pyansys-automation@users.noreply.github.com> Date: Mon, 1 Dec 2025 05:16:58 +0100 Subject: [PATCH 1/7] chore: update CODE_OF_CONDUCT.md file --- CODE_OF_CONDUCT.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 5a9533d3..f7137cad 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -57,9 +57,9 @@ further defined and clarified by project maintainers. This code of conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at -https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq + From 9aab3901a421146dd405d73fc95c85f47eb93cc0 Mon Sep 17 00:00:00 2001 From: PyAnsys Automation bot <214123248+pyansys-automation@users.noreply.github.com> Date: Mon, 1 Dec 2025 05:17:00 +0100 Subject: [PATCH 2/7] chore: update CONTRIBUTING.md file --- CONTRIBUTING.md | 70 +++---------------------------------------------- 1 file changed, 3 insertions(+), 67 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5210d5a..5d752a14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,74 +3,10 @@ Overall guidance on contributing to a PyAnsys library appears in the [Contributing] topic in the *PyAnsys developer's guide*. Ensure that you are thoroughly familiar with this guide before attempting to contribute to -ansys-tools. +{project-name}. -The following contribution information is specific to *Ansys Tools*. +The following contribution information is specific to {project-name}. [Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html -## Clone the repository - -To clone and install the latest *Ansys Tools* release in development mode, run -these commands: - -```bash -git clone https://github.com/ansys/ansys-tools-common/ -cd ansys-tools -python -m pip install --upgrade pip -pip install -e . -``` - -## Adhere to code style - -*Ansys Tools* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit. - -To ensure your code meets minimum code styling standards, run these commands: - -```bash -pip install pre-commit -pre-commit run --all-files -``` - -You can also install this as a pre-commit hook by running this command: - -```bash -pre-commit install -``` - -## Run the tests - -Prior to running the tests, you must run this command to install the test dependencies: - -```bash -pip install -e .[tests] -``` - -To run the tests, navigate to the root directory of the repository and run this command: - -```bash -pytest -``` - - -## Build the documentation - -Prior to building the documentation, you must run this command to install the documentation dependencies: - -```bash -pip install -e .[doc] -``` - -To build the documentation, run the following commands: - -```bash -cd doc - -# On linux -make html - -# On windows -./make.bat html -``` - -The documentation is built in the `docs/_build/html` directory. + From e11fddacef8be72aa1db5176b002a7ea6a37d528 Mon Sep 17 00:00:00 2001 From: PyAnsys Automation bot <214123248+pyansys-automation@users.noreply.github.com> Date: Mon, 1 Dec 2025 05:17:02 +0100 Subject: [PATCH 3/7] chore: update LICENSE file --- LICENSE | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index 1a6cfdd5..f6b4c397 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,13 @@ MIT License -Copyright (c) 2025 ANSYS, Inc. and/or its affiliates. +Copyright (c) 2025 - 2025 ANSYS, Inc. and/or its affiliates. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE. \ No newline at end of file From dc21b79bc06206d52dde2171a9487595fdbe90f5 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 1 Dec 2025 04:17:21 +0000 Subject: [PATCH 4/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index f6b4c397..e488f76c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 - 2025 ANSYS, Inc. and/or its affiliates. +Copyright (c) 2025 ANSYS, Inc. and/or its affiliates. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in From 47af71bd4f5e985d5410cf9bd20838a0f63d6b8d Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Mon, 1 Dec 2025 04:17:50 +0000 Subject: [PATCH 5/7] chore: adding changelog file 122.miscellaneous.md [dependabot-skip] --- doc/source/changelog/122.miscellaneous.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/source/changelog/122.miscellaneous.md diff --git a/doc/source/changelog/122.miscellaneous.md b/doc/source/changelog/122.miscellaneous.md new file mode 100644 index 00000000..64e808bd --- /dev/null +++ b/doc/source/changelog/122.miscellaneous.md @@ -0,0 +1 @@ +Chore: Update missing or outdated files From ec6f301a27050a1f59b50fb334a3fef0c0ab6ed9 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Mon, 1 Dec 2025 09:07:15 +0100 Subject: [PATCH 6/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d752a14..d2161e87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,3 +10,69 @@ The following contribution information is specific to {project-name}. [Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html + +## Clone the repository + +To clone and install the latest *Ansys Tools* release in development mode, run +these commands: + +```bash +git clone https://github.com/ansys/ansys-tools-common/ +cd ansys-tools +python -m pip install --upgrade pip +pip install -e . +``` + +## Adhere to code style + +*Ansys Tools* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit. + +To ensure your code meets minimum code styling standards, run these commands: + +```bash +pip install pre-commit +pre-commit run --all-files +``` + +You can also install this as a pre-commit hook by running this command: + +```bash +pre-commit install +``` + +## Run the tests + +Prior to running the tests, you must run this command to install the test dependencies: + +```bash +pip install -e .[tests] +``` + +To run the tests, navigate to the root directory of the repository and run this command: + +```bash +pytest +``` + + +## Build the documentation + +Prior to building the documentation, you must run this command to install the documentation dependencies: + +```bash +pip install -e .[doc] +``` + +To build the documentation, run the following commands: + +```bash +cd doc + +# On linux +make html + +# On windows +./make.bat html +``` + +The documentation is built in the `docs/_build/html` directory. From 0aa7e52e91bdcab7fa70d3e37f9660a21c99c489 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Mon, 1 Dec 2025 09:07:48 +0100 Subject: [PATCH 7/7] Apply suggestions from code review --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2161e87..4f7e72fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,9 +3,9 @@ Overall guidance on contributing to a PyAnsys library appears in the [Contributing] topic in the *PyAnsys developer's guide*. Ensure that you are thoroughly familiar with this guide before attempting to contribute to -{project-name}. +ansys-tools-common. -The following contribution information is specific to {project-name}. +The following contribution information is specific to *Ansys Tools*. [Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html