Skip to content

update DEVELOPER_GUIDE.md to ensure the requirement of adding resources in wrapper librabry #513

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
dbasunag merged 2 commits into from
Aug 12, 2025
Merged

update DEVELOPER_GUIDE.md to ensure the requirement of adding resources in wrapper librabry #513

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a47e98d
update DEVELOPER_GUIDE.md to ensure the requirement of adding resourc…
dbasunag Aug 11, 2025
bb4c5fa
Merge branch 'main' into update_doc
dbasunag Aug 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
6 changes: 6 additions & 0 deletions docs/DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ The project utilizes [openshift-python-wrapper](https://github.com/RedHatQE/open
Please refer to the [documentation](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/README.md)
and the [examples](https://github.com/RedHatQE/openshift-python-wrapper/tree/main/examples) for more information.

For any missing resources, please generate a new resource using
[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md) and
create a PR against wrapper. Calls to cluster resources from tests, utils and fixtures must always use
openshift-python-wrapper resource or oc command
(when wrapper resource is not relevant. e.g. must-gather generation)

Comment on lines +69 to +74
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Tighten language, fix grammar/consistency, and format oc

Refines phrasing, aligns “utils” to “utilities” (consistent with earlier sections), clarifies “resource class,” adds missing articles/punctuation, and formats oc as a command.

Apply this diff:

-For any missing resources, please generate a new resource using
-[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md) and
-create a PR against wrapper. Calls to cluster resources from tests, utils and fixtures must always use
-openshift-python-wrapper resource or oc command
-(when wrapper resource is not relevant. e.g. must-gather generation)
+For any missing resources, generate a new resource class using the
+[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md),
+and open a PR against the
+[openshift-python-wrapper repository](https://github.com/RedHatQE/openshift-python-wrapper).
+Calls to cluster resources from tests, utilities, and fixtures must use an
+openshift-python-wrapper resource; when a wrapper resource is not relevant
+(e.g., must-gather generation), use the `oc` command.

Optionally verify external links resolve (HTTP 200):

🏁 Script executed:

#!/bin/bash
set -euo pipefail

urls=(
  "https://github.com/RedHatQE/openshift-python-wrapper/blob/main/README.md"
  "https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md"
)

for u in "${urls[@]}"; do
  code=$(curl -s -o /dev/null -w "%{http_code}" "$u")
  echo "$code  $u"
done
# Expect: 200 for each URL

Length of output: 872

docs/DEVELOPER_GUIDE.md (lines 69–74): refine phrasing, fix grammar & consistency

To improve clarity and align with existing terminology, apply this diff:

-For any missing resources, please generate a new resource using
-[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md) and
-create a PR against wrapper. Calls to cluster resources from tests, utils and fixtures must always use
-openshift-python-wrapper resource or oc command
-(when wrapper resource is not relevant. e.g. must-gather generation)
+For any missing resources, generate a new resource class using the
+[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md),
+and open a PR against the
+[openshift-python-wrapper repository](https://github.com/RedHatQE/openshift-python-wrapper).
+Calls to cluster resources from tests, utilities, and fixtures must use an
+openshift-python-wrapper resource; when a wrapper resource is not relevant
+(e.g., must-gather generation), use the `oc` command.
  • “utilities” replaces “utils” for consistency.
  • Added “class” after “resource” for precision.
  • Linked both the class_generator tool and the wrapper repo directly.
  • Formatted oc as inline code.
  • Updated punctuation in parenthetical for standard style.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
For any missing resources, please generate a new resource using
[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md) and
create a PR against wrapper. Calls to cluster resources from tests, utils and fixtures must always use
openshift-python-wrapper resource or oc command
(when wrapper resource is not relevant. e.g. must-gather generation)
For any missing resources, generate a new resource class using the
[class_generator tool](https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md),
and open a PR against the
[openshift-python-wrapper repository](https://github.com/RedHatQE/openshift-python-wrapper).
Calls to cluster resources from tests, utilities, and fixtures must use an
openshift-python-wrapper resource; when a wrapper resource is not relevant
(e.g., must-gather generation), use the `oc` command.
🤖 Prompt for AI Agents 
In docs/DEVELOPER_GUIDE.md around lines 69–74, refine the paragraph to replace
"utils" with "utilities", add the word "class" after each occurrence of
"resource" for precision, change the existing tool link to directly reference
the class_generator README and also link the wrapper repo homepage, format the
oc command as inline code (i.e., use the project's inline code style for `oc`),
and update the parenthetical punctuation to standard style (e.g., include
periods and commas inside parentheses as needed); make these phrasing and
grammar adjustments while preserving the original meaning about generating
missing resources and using wrapper classes or the oc command when appropriate.


## Conftest
- Top level [conftest.py](../conftest.py) contains pytest native fixtures.
Expand Down
Loading