Skip to content

docs: homogenizing commit/branches/pull request prefix #3737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 12, 2025
Merged

docs: homogenizing commit/branches/pull request prefix #3737

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
87c8ecc
docs: homogenizing prefixes
germa89 Feb 12, 2025
27da1eb
docs: improving table header
germa89 Feb 12, 2025
528b748
chore: adding changelog file 3737.documentation.md [dependabot-skip]
pyansys-ci-bot Feb 12, 2025
63002fd
chore: adding changelog file 3737.documentation.md [dependabot-skip]
pyansys-ci-bot Feb 12, 2025
fca80dc
chore: adding changelog file 3737.documentation.md [dependabot-skip]
pyansys-ci-bot Feb 12, 2025
16e8b3d
feat: adding vale exception
germa89 Feb 12, 2025
b964089
Merge branch 'docs/homgenizing-prefix' of https://github.com/ansys/py…
germa89 Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/3737.documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: homgenizing-prefix
109 changes: 84 additions & 25 deletions doc/source/getting_started/develop_pymapdl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,35 +63,46 @@
#. **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 <table_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.

Check failure on line 96 in doc/source/getting_started/develop_pymapdl.rst

View workflow job for this annotation

GitHub Actions / Documentation style doc 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'maint'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'maint'?", "location": {"path": "doc/source/getting_started/develop_pymapdl.rst", "range": {"start": {"line": 96, "column": 7}}}, "severity": "ERROR"}
- `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 <table_prefix_>`_.

#. **Commit frequently**: Make small, meaningful commits frequently. Avoid
making a large number of unrelated changes in a single commit.
Expand All @@ -105,17 +116,19 @@
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.

Check failure on line 124 in doc/source/getting_started/develop_pymapdl.rst

View workflow job for this annotation

GitHub Actions / Documentation style doc 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'maint'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'maint'?", "location": {"path": "doc/source/getting_started/develop_pymapdl.rst", "range": {"start": {"line": 124, "column": 7}}}, "severity": "ERROR"}
- `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 <table_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
Expand Down Expand Up @@ -149,6 +162,52 @@
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 (``prefix:``) | Branch (``prefix/``) | Pull-request (``prefix:``) |
+=============+=============================+==============================+==================================+
| `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:| |

Check failure on line 188 in doc/source/getting_started/develop_pymapdl.rst

View workflow job for this annotation

GitHub Actions / Documentation style doc 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'maint'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'maint'?", "location": {"path": "doc/source/getting_started/develop_pymapdl.rst", "range": {"start": {"line": 188, "column": 4}}}, "severity": "ERROR"}
+-------------+-----------------------------+------------------------------+----------------------------------+
| `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:

Expand Down
Loading