Skip to content

Docs codex guidance - #3661

Closed
ali-zein232 wants to merge 3 commits into
TheSuperHackers:mainfrom
ali-zein232:docs-codex-guidance
Closed

ali-zein232 wants to merge 3 commits into
TheSuperHackers:mainfrom
ali-zein232:docs-codex-guidance

Conversation

@ali-zein232

Copy link
Copy Markdown

No description provided.

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request adds contributor and mentoring guidance for Generals Zero Hour. It also adds a project progress record covering repository setup, build and gameplay testing, FPS HUD investigation, learning milestones, and progress updates.

Changes

Project guidance and progress

Layer / File(s) Summary
Mentoring and contributor workflow
AGENTS.md, MENTORING_GUIDELINES.md
The documents set project-specific workflow instructions and describe mentoring practices, tool use, code-change rules, and learning goals.
Project progress record
PROJECT_PROGRESS.md
The document records repository and build setup, gameplay testing, FPS HUD investigation, learning milestones, and progress-update instructions.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested labels: Minor

Suggested reviewers: xezon

Merge Risk: Low · up to c20eb

The guidance can omit unresolved experiment failures or direct a push to the wrong repository. These localized documentation issues warrant correction but do not block merging with owner awareness.

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@ali-zein232 ali-zein232 closed this Nov 6, 2026
@greptile-apps

greptile-apps Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 4/5

[Low impact] The changes affect how coding assistants approach work in this repository.

The PR appears safe to merge, with a non-blocking concern about applying personal mentoring instructions to every contributor.

Findings

  1. P2 Personal instructions apply to everyone ▶

Summary

Adds Codex guidance, a personal mentoring agreement, and progress notes for building and investigating Zero Hour.

  • Coding assistants get mentoring rules and project notes before starting work.

Reviews (1) · Last reviewed commit: "Add project-wide Codex guidance" · Reviewed by Greptile

@ali-zein232
ali-zein232 deleted the docs-codex-guidance branch November 6, 2026 02:43
Comment thread AGENTS.md
Comment on lines +5 to +10
Before starting work, read:
- MENTORING_GUIDELINES.md
- PROJECT_PROGRESS.md

These documents describe my learning goals, preferences,
development environment, and project progress.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Personal instructions apply to everyone

The root AGENTS.md makes one contributor’s mentoring agreement apply to everyone using Codex in this repository. It requires personal progress notes, assumes a particular Windows setup, and directs unrelated contributions into PROJECT_PROGRESS.md. This gives other contributors guidance based on someone else’s machine and learning goals. Keep shared development guidance here, and move the personal mentoring instructions to an opt-in document or the personal fork.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@ali-zein232
ali-zein232 restored the docs-codex-guidance branch November 6, 2026 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant