Qodo Merge Auto-Generated Best Practices 🚀

[qodo-code-review]

Your Auto-Generated Repo's Best Practices File

By analyzing your repository's PR discussions from the past year, we've generated an initial best_practices.md file tailored to your codebase.
This file contains insights extracted from your team's code reviews and discussions, and will help Qodo Merge to give more tailored code suggestions.

Note - This file aims to capture specific patterns to your repository's workflow and discussions, rather than providing more generic best practices. We hope this auto-generated file can serve as a foundation that the team will continue to refine and expand with additional relevant patterns over time.

Steps to Utilize This File:

1. Review the generated best_practices.md file in this PR
2. Edit the file if needed. For example, remove irrelevant patterns, or add new ones.
3. Commit the modified file. Afterwards, Qodo Merge will utilize it automatically to generate best-practices suggestions for new PRs.

Happy coding!

https://issues.redhat.com/browse/RHIDP-6736

[zdrapela]

/describe

[qodo-code-review]

PR Type

(Describe updated until commit 45a5405)

Documentation

---

Description

• Add auto-generated best practices file with 5 coding patterns

• Include examples for documentation, Kubernetes resources, and shell scripts

• Provide before/after code examples with links to past PR discussions

---

File Walkthrough

	Relevant files
Documentation	best_practices.md Add repository-specific coding best practices guide            best_practices.md Create comprehensive best practices file with 5 coding patterns Include before/after code examples for each pattern Add links to relevant past PR discussions for context Cover documentation, Kubernetes manifests, autoscaling, and shell scripting +164/-0

---

[zdrapela]

/describe

[zdrapela]

/describe

[zdrapela]

/compliance

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟡	🎫 #RHIDP-6736 🔴 Refactor all bash scripts under .ibm/pipelines to be maintainable and consistent, including adding a #!/bin/bash shebang and proper ShellCheck-compatible sourcing. Deduplicate shell code and replace repeated snippets with reusable functions. Standardize creation of Secrets and ConfigMaps (e.g., via `envsubst`) across scripts. Validate and fail early on required environment variables (e.g., set -u) and improve logging while masking sensitive data. Break down `utils.sh` into smaller, focused modules. Unify namespace and project into a single variable (namespace), using project only where OCP-specific. Unify configuration between OCP vs. generic K8s and Helm chart vs. Operator (ideally configured once, reused everywhere). Enable and adopt tooling (Bash Language Server, ShellCheck, shfmt) across all CI scripts. Unify e2e test skipping/targeting using test.skip and test.fixme patterns (e.g., always skip on K8s for OCP-only tests; mark currently broken operator tests with fixme). Update documentation with best practices for developing CI scripts and for skipping tests. Consider adding ShellCheck and shfmt as pre-commit hooks and GitHub Actions to keep scripts clean. Refactor CI jobs (in openshift/release) to have a folder structure based on platform (OCP, AKS, GKE, ...), install method (Helm, Operator), and cadence (pull, nightly). Use Bats to produce JUnit results consumable by ReportPortal to improve reporting. Goals: minimize deployment-caused failures, improve debuggability, ease extension for new features and cluster types, and unify test skipping strategy. ⚪ Acceptance criteria: upstream documentation updates and a technical enablement/demo.
Codebase Duplication Compliance
🟢	No codebase code duplication found No new components were introduced in the PR code
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[rm3l]

Makes sense overall as it is. Let's merge this for now and we can continue refining this over time.

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rm3l

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [rm3l]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment