derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
# TheRock style guides
|
|
|
|
> [!IMPORTANT]
|
|
> These style guides are living documents meant to steer developers towards
|
|
> agreed upon best practices.
|
|
>
|
|
> 📝 Feel free to propose edits 📝
|
|
|
|
## Language and tool-specific guides
|
|
|
|
- [Bash Style Guide](bash_style_guide.md)
|
|
- [CMake Style Guide](cmake_style_guide.md)
|
|
- [GitHub Actions Style Guide](github_actions_style_guide.md)
|
|
- [Python Style Guide](python_style_guide.md)
|
|
|
|
## Core principles
|
|
|
|
TheRock is the central build/test/release repository for dozens of ROCm
|
|
subprojects and external builds. Tooling in this repository is shared across
|
|
multiple repositories.
|
|
|
|
These are some of our guiding principles:
|
|
|
|
- Optimize for readability and debuggability
|
|
- Explicit is better than implicit
|
|
- [Don't repeat yourself (DRY)](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
|
|
- [You aren't gonna need it (YAGNI)](https://en.wikipedia.org/wiki/You_aren%27t_gonna_need_it)
|
|
- [Keep it simple, silly (KISS)](https://en.wikipedia.org/wiki/KISS_principle)
|
|
- Write portable code where possible, across...
|
|
- Operating systems (Linux distributions, Windows)
|
|
- Devices (dcgpu, dgpu, igpu, apu, etc.)
|
|
- Software versions (e.g. Python)
|
|
- Collaborate with upstream projects
|
|
|
|
### Formatting using pre-commit hooks
|
|
|
|
We enforce formatting for certain languages using
|
|
[_pre-commit_](https://pre-commit.com/) with hooks defined in
|
|
[`.pre-commit-config.yaml`](/.pre-commit-config.yaml).
|
|
|
|
To get started with pre-commit:
|
|
|
|
```bash
|
|
# Download.
|
|
pip install pre-commit
|
|
|
|
# Run locally on staged files.
|
|
pre-commit run
|
|
|
|
# Run locally on all files.
|
|
pre-commit run --all-files
|
|
|
|
# (Optional but recommended)
|
|
# Install git hook. Now pre-commit runs on every git commit.
|
|
pre-commit install
|
|
```
|