Skip to content
Snippets Groups Projects

ActivateControllerAction

Merged René Paris requested to merge feature/update_ose_head into develop
Files
118
@@ -240,3 +240,46 @@ To format the code using ClangFormat, run the following command in the terminal:
clang-format -i [source_file(s)]
Replace `[source_file(s)]` with the path(s) to the file(s) to format. The `-i` option tells ClangFormat to modify the files in-place.
Commit Message Guidelines
-------------------------
**Overview**
This section outlines the guidelines for writing commit messages in openPASS repository. Following these guidelines ensures that commit messages are clear, descriptive, and help facilitate collaboration among team members.
This section uses excerpts from `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ licensed under `CC BY 3.0 <https://creativecommons.org/licenses/by/3.0/>`_ by it's authors.
**Commit Message Format**
Each commit message should consist of a single short summary line (recommended, up to 50 characters) followed by a more detailed description (if necessary).
The message should adhere to the following format:
.. code-block::
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
#. The ``<type>`` part represents the type of the commit, which helps in categorizing the nature of the changes. The following types are allowed:
* ``feat``: A new feature or enhancement.
* ``fix``: A bug fix.
* ``docs``: Documentation-related changes.
* ``style``: Code style changes (e.g., formatting, spacing).
* ``refactor``: Code refactoring without adding new features or fixing bugs.
* ``test``: Adding or improving tests.
* ``chore``: Maintenance tasks, build changes, or other non-functional modifications.
* ``ci``: Changes related to CI.
* ``build``: Modifications related to build step.
* ``perf``: Modifications related to performance improvements.
* ``revert``: Revert any code changes.
#. The ``<optional scope>`` section is optional but is used to provide additional contextual information and is contained within parenthesis.
#. The ``<description>`` is a brief description of the changes made in the commit. It should be concise yet informative and is recommended to not exceed 50 characters.
#. The ``<optional body>`` section is optional but recommended, especially for complex changes or when further explanation is needed. This section should provide additional context, justification, and details about the changes made. Use bullet points for better readability when necessary.
#. The ``<optional footer>`` section is also optional but can be used to provide supplementary information related to the commit.
\ No newline at end of file
Loading