Skip to content

Conversation

@davo0411
Copy link
Collaborator

@davo0411 davo0411 commented Sep 27, 2025

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive reference/template for creating new graphics features in Community Shaders. It details required project structure, how to register features with the core system, guidance for customizing class names/metadata/settings and VR support, naming conventions, integration with the build process, and a testing checklist. This is docs-only and introduces no runtime or behavioral changes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 27, 2025

Walkthrough

Adds a new documentation template file that documents required file structure, registration steps (Globals.h/Globals.cpp/Feature.cpp), customization guidance, naming conventions, build integration, and a testing checklist. No executable code or public API changes.

Changes

Cohort / File(s) Summary
Documentation template
new-feature-template/NewFeatureReadme.md
Adds a comprehensive template/readme for creating and registering new graphics features (required file structure, Globals.h/Globals.cpp/Feature.cpp registration steps, template customization, naming conventions, automatic build integration, and testing checklist). No executable changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • doodlum
  • alandtse

Poem

A nibble of notes in a tidy new sheet,
I thump my paws—templates complete!
Paths and names in burrows align,
Builds hop smoothly, tests look fine.
Carrots for structure, parsley for flow—
Documentation planted, now features can grow! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly and concisely describes the main change of adding a documentation guide for new feature development templates, which directly matches the addition of NewFeatureReadme.md. It avoids vague wording, file lists, or extraneous details, making it immediately understandable to reviewers. The “docs:” prefix appropriately signals a documentation update.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2984566 and bab6fc2.

📒 Files selected for processing (1)
  • new-feature-template/NewFeatureReadme.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • new-feature-template/NewFeatureReadme.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Validate shader compilation (Flatrim, .github/configs/shader-validation.yaml)
  • GitHub Check: Build plugin and addons
  • GitHub Check: Validate shader compilation (VR, .github/configs/shader-validation-vr.yaml)

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Automated formatting by clang-format, prettier, and other hooks.
See https://pre-commit.ci for details.
@github-actions
Copy link

Using provided base ref: e91f159
Using base ref: e91f159
Base commit date: 2025-09-27T07:51:01+01:00 (Saturday, September 27, 2025 07:51 AM)
No actionable suggestions for changed features.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e91f159 and 2984566.

📒 Files selected for processing (1)
  • new-feature-template/NewFeatureReadme.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-17T18:37:35.839Z
Learnt from: CR
PR: doodlum/skyrim-community-shaders#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T18:37:35.839Z
Learning: Applies to features/*/Shaders/**/*.{hlsl,hlsli,fx,fxh} : Place all feature shaders under features/YourFeature/Shaders/

Applied to files:

  • new-feature-template/NewFeatureReadme.md
📚 Learning: 2025-08-17T18:37:35.839Z
Learnt from: CR
PR: doodlum/skyrim-community-shaders#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T18:37:35.839Z
Learning: Applies to features/**/*.{cpp,cxx,cc,h,hpp,hxx} : Register new features in the globals::features namespace

Applied to files:

  • new-feature-template/NewFeatureReadme.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Validate shader compilation (Flatrim, .github/configs/shader-validation.yaml)
  • GitHub Check: Validate shader compilation (VR, .github/configs/shader-validation-vr.yaml)
  • GitHub Check: Build plugin and addons

@github-actions
Copy link

github-actions bot commented Sep 27, 2025

✅ A pre-release build is available for this PR:
Download

davo0411 and others added 2 commits October 6, 2025 17:05
Automated formatting by clang-format, prettier, and other hooks.
See https://pre-commit.ci for details.
@doodlum doodlum merged commit 84e0da3 into doodlum:dev Oct 9, 2025
15 checks passed
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.

2 participants