Skip to content

Commit

Permalink
Rephrase section names
Browse files Browse the repository at this point in the history
  • Loading branch information
azriel1rf committed May 4, 2024
1 parent 5011f35 commit db99870
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,17 @@ Test:
python3 -m unittest discover -v
```

## GitHub Actions
## Continuous Integration (CI) with GitHub Actions

We use GitHub Actions to automate various checks and tests for every Pull Request.
If the build, tests, type checking, or package installation fails, the workflow will
exit with a non-zero status code. Linting errors or files formatted by pre-commit
will cause the workflow to exit with status code 1. If any job exits with a non-zero
status code, merging or pushing to the repository will be blocked by GitHub Actions.

For every commit, the following pre-commit checks are performed:
### Pre-commit Checks for Every Commit

The following pre-commit checks are performed:

* Prevent commits to the `master` or `develop` branches
* Check for merge conflicts
Expand All @@ -113,14 +115,18 @@ For every commit, the following pre-commit checks are performed:
* Display the differences between the original and formatted code, if any files
are formatted by pre-commit

For C++, the following checks are performed:
### CI Checks for C++

The following checks are performed:

* C++ build and unit tests
* Pre-commit checks:
* Lint C++ code format according to the style specified in `.clang-format` (for
modified files)

For Python, the following checks are performed:
### CI Checks for Python

The following checks are performed:

* Python unit tests for Python 3.8 to 3.11
* Python type checking with `mypy` for Python 3.8
Expand All @@ -130,7 +136,9 @@ For Python, the following checks are performed:
* Lint Python files with `Ruff` according to the configuration in `pyproject.toml`
(if any Python files are modified, check all Python files)

For certain file types, additional pre-commit checks are performed:
### CI Checks for Certain File Types

Additional pre-commit checks are performed:

* Check YAML formatting (for modified files)
* Check TOML formatting (for modified files)
Expand Down

0 comments on commit db99870

Please sign in to comment.