From 87c8ecc536063457821fc1c74b9337d75a931a09 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Wed, 12 Feb 2025 18:40:53 +0100 Subject: [PATCH 1/6] docs: homogenizing prefixes --- .../getting_started/develop_pymapdl.rst | 109 ++++++++++++++---- 1 file changed, 84 insertions(+), 25 deletions(-) diff --git a/doc/source/getting_started/develop_pymapdl.rst b/doc/source/getting_started/develop_pymapdl.rst index 242a7ef2f6d..bf9589995d3 100644 --- a/doc/source/getting_started/develop_pymapdl.rst +++ b/doc/source/getting_started/develop_pymapdl.rst @@ -63,35 +63,46 @@ guidelines for developing code in a repository: #. **Use branches**: Create branches for different features, bug fixes, or experiments. This keeps changes isolated and facilitates parallel development. The CI/CD checks that the branch name is compliant. For example, - the branch name must start with a prefix and a backslash. + the branch name must start with a lower case prefix and a backslash. The allowed prefixes are: - - `fix/` - Bug fixes. - - `feat/` - Changes that introduce a new feature or significant addition. - - `maint/` - General maintenance of the repository. For instance, improving the CI/CD workflows. + - `build/` - Changes that affect the build system or external dependencies (such as to ``pip`` or ``make``). + - `ci/` - Changes to the CI/CD configuration files and scripts. + - `dependabot/` - Created by Dependabot. - `docs/` - Improves documentation and examples. + - `feat/` - Changes that introduce a new feature or significant addition. + - `fix/` - Bug fixes. + - `junk/` - Other purposes. It should not be used for branches that are going to be merged to ``main``. + - `maint/` - General maintenance of the repository. - `no-ci/` - (Not applicable to PyMAPDL) In some repositories, branches with this prefix do not trigger CI/CD. - - `test/` - Improvements or changes to testing. - - `testing/` - For testing and debugging. It should not be used for branches that are going to be merged to ``main``. + - `perf/` - A code change that improves performance. + - `refactor/` - A code change that neither fixes a bug nor adds a feature. - `release/` - Contains the released versions changes. - - `dependabot/` - Created by Dependabot. - - `junk/` - Other purposes. It should not be used for branches that are going to be merged to ``main``. + - `revert/` - Reverts a previous commit. + - `testing/` - For testing and debugging. It can be used to add new tests. + + **Note**: For more information, see `Table of allowed prefix `_. #. **Write descriptive commit messages**: Provide clear and concise commit messages that explain the purpose and context of the changes. Follow a consistent style. - - `fix:` - Bug fixes. - - `feat:` - Changes that introduce a new feature or significant addition. - - `docs:` - Changes pertaining only to documentation. - - `style:` - Changes that do not affect the meaning of the code (such as white space, formatting, and missing semicolons). - - `refactor:` - A code change that neither fixes a bug nor adds a feature. - - `perf:` - A code change that improves performance. - - `test:` - Improvements or changes to testing. - `build:` - Changes that affect the build system or external dependencies (such as to ``pip`` or ``make``). + - `chore:` - Other changes that don't modify the code. It can be used as a fall back general branch name. - `ci:` - Changes to the CI/CD configuration files and scripts. - - `chore:` - Other changes that don't modify the code (such as releasing and versioning). + - `docs:` - Improves documentation and examples. + - `feat:` - Changes that introduce a new feature or significant addition. + - `fix:` - Bug fixes. + - `maint:` - General maintenance of the repository. + - `no-ci:` - (Not applicable to PyMAPDL) In some repositories, branches with this prefix do not trigger CI/CD. + - `perf:` - A code change that improves performance. + - `refactor:` - A code change that neither fixes a bug nor adds a feature. + - `release:` - Contains the released versions changes. - `revert:` - Reverts a previous commit. + - `style:` - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). + - `testing:` - For testing and debugging. It can be used to add new tests. + + **Note**: For more information, see `Table of allowed prefix `_. #. **Commit frequently**: Make small, meaningful commits frequently. Avoid making a large number of unrelated changes in a single commit. @@ -105,17 +116,19 @@ guidelines for developing code in a repository: Pull requests must follow the same convention as the commit messages. The following prefixes are allowed in the pull request names: - - `fix:` - Bug fixes. - - `feat:` - Changes that introduce a new feature or significant addition. - - `docs:` - Changes pertaining only to documentation. - - `style:` - Changes that do not affect the meaning of the code (such as white space, formatting, and missing semicolons). - - `refactor:` - A code change that neither fixes a bug nor adds a feature. - - `perf:` - A code change that improves performance. - - `test:` - Improvements or changes to testing. - `build:` - Changes that affect the build system or external dependencies (such as to ``pip`` or ``make``). - `ci:` - Changes to the CI/CD configuration files and scripts. - - `chore:` - Other changes that don't modify the code (such as releasing and versioning). - - `revert:` - Reverts a previous pull request. + - `docs:` - Improves documentation and examples. + - `feat:` - Changes that introduce a new feature or significant addition. + - `fix:` - Bug fixes. + - `maint:` - General maintenance of the repository. + - `no-ci:` - (Not applicable to PyMAPDL) In some repositories, branches with this prefix do not trigger CI/CD. + - `perf:` - A code change that improves performance. + - `refactor:` - A code change that neither fixes a bug nor adds a feature. + - `revert:` - Reverts a previous commit. + - `testing:` - For testing and debugging. It can be used to add new tests. + + **Note**: For more information, see `Table of allowed prefix `_. The pull requests can also be labeled for easier repository maintenance. The CI/CD automatically labels each pull request based on the pull requests prefix and @@ -149,6 +162,52 @@ guidelines for developing code in a repository: By following these guidelines, you can ensure smooth and organized code development within a repository, fostering collaboration, code quality, and feature enhancement. +**Table of allowed prefix** + +.. _table_prefix: + ++-------------+-----------------------------+------------------------------+----------------------------------+ +| prefix | Commit | Branch | Pull-request | ++=============+=============================+==============================+==================================+ +| `build` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `dependabot`| |:x:| | |:white_check_mark:| | |:x:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `chore` | |:white_check_mark:| | |:x:| | |:x:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `ci` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `docs` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `feat` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `fix` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `junk` | |:x:| | |:white_check_mark:| | |:x:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `maint` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `no-ci` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `perf` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `refactor` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `release` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `revert` | |:white_check_mark:| | |:white_check_mark:| | |:x:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `style` | |:white_check_mark:| | |:x:| | |:x:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ +| `testing` | |:white_check_mark:| | |:white_check_mark:| | |:x:| | ++-------------+-----------------------------+------------------------------+----------------------------------+ + + +Where: + +* |:white_check_mark:| means that the prefix is allowed. +* |:x:| means that the prefix is not allowed. + .. _ref_unit_testing_contributing: From 27da1ebc70d7f4bc170140173d23ee445645b2e2 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Wed, 12 Feb 2025 18:42:28 +0100 Subject: [PATCH 2/6] docs: improving table header --- doc/source/getting_started/develop_pymapdl.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/develop_pymapdl.rst b/doc/source/getting_started/develop_pymapdl.rst index bf9589995d3..d0786ee22b7 100644 --- a/doc/source/getting_started/develop_pymapdl.rst +++ b/doc/source/getting_started/develop_pymapdl.rst @@ -167,7 +167,7 @@ development within a repository, fostering collaboration, code quality, and feat .. _table_prefix: +-------------+-----------------------------+------------------------------+----------------------------------+ -| prefix | Commit | Branch | Pull-request | +| Prefix | Commit (``prefix:``) | Branch (``prefix/``) | Pull-request (``prefix:``) | +=============+=============================+==============================+==================================+ | `build` | |:white_check_mark:| | |:white_check_mark:| | |:white_check_mark:| | +-------------+-----------------------------+------------------------------+----------------------------------+ From 528b74819f8c3e8941784c58acf5a14e55101173 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Wed, 12 Feb 2025 17:44:08 +0000 Subject: [PATCH 3/6] chore: adding changelog file 3737.documentation.md [dependabot-skip] --- doc/changelog.d/3737.documentation.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/3737.documentation.md diff --git a/doc/changelog.d/3737.documentation.md b/doc/changelog.d/3737.documentation.md new file mode 100644 index 00000000000..1f07d9c9863 --- /dev/null +++ b/doc/changelog.d/3737.documentation.md @@ -0,0 +1 @@ +docs: homgenizing-prefix \ No newline at end of file From 63002fd47e207f09f57d4d3109cb7e2c23f464c7 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Wed, 12 Feb 2025 17:45:54 +0000 Subject: [PATCH 4/6] chore: adding changelog file 3737.documentation.md [dependabot-skip] --- doc/changelog.d/3737.documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changelog.d/3737.documentation.md b/doc/changelog.d/3737.documentation.md index 1f07d9c9863..40bf7e12124 100644 --- a/doc/changelog.d/3737.documentation.md +++ b/doc/changelog.d/3737.documentation.md @@ -1 +1 @@ -docs: homgenizing-prefix \ No newline at end of file +docs: homgenizing commit/branches/pull request prefix \ No newline at end of file From fca80dcfdf23fc61126efd3ee7bd0ffb35b8d833 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Wed, 12 Feb 2025 19:07:27 +0000 Subject: [PATCH 5/6] chore: adding changelog file 3737.documentation.md [dependabot-skip] --- doc/changelog.d/3737.documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changelog.d/3737.documentation.md b/doc/changelog.d/3737.documentation.md index 40bf7e12124..d4a6f9c19c0 100644 --- a/doc/changelog.d/3737.documentation.md +++ b/doc/changelog.d/3737.documentation.md @@ -1 +1 @@ -docs: homgenizing commit/branches/pull request prefix \ No newline at end of file +docs: homogenizing commit/branches/pull request prefix \ No newline at end of file From 16e8b3d8e14dd4dc3f1fb5003488bf3fa47b1683 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Wed, 12 Feb 2025 20:07:37 +0100 Subject: [PATCH 6/6] feat: adding vale exception --- doc/styles/config/vocabularies/ANSYS/accept.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt index 493aa3b9d97..b75472ead23 100644 --- a/doc/styles/config/vocabularies/ANSYS/accept.txt +++ b/doc/styles/config/vocabularies/ANSYS/accept.txt @@ -58,9 +58,9 @@ datas delet Dependabot Dev -Dimitris devcontainer DevContainer +Dimitris dof ect eigenfrequency @@ -88,9 +88,9 @@ hexahedral hostname HTML Image[Mm]agick -Ioannis imagin importlib +Ioannis ist Julia Kalogeris @@ -103,6 +103,7 @@ levl Linder Linux MacOS +maint mapdl MAPDL mater