Enhanced guidelines for AI and Humans #112
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
lefticus
commented
Apr 30, 2025
lefticus
commented
- additional tool support
- strict settings on lizard
* Add AI_GUIDELINES.md with framework-agnostic instructions for AI tools * Add HUMAN_GUIDELINES.md with project philosophy and best practices * Implement Lizard code complexity analyzer with configurable thresholds * Add consistent missing tool warnings with option to treat as errors * Set up HTML and XML report generation for Lizard * Improve CMake warnings handling with myproject_WARNING_TYPE variable * Ensure clang-format is used to maintain consistent code style
* Add detailed Modern C++ Coding Guidelines section * Add guidelines for ensuring code quality with project tools * Implement copy-paste detection in Lizard * Add missing tools detection guidance * Include preferred build configuration * Add development workflow recommendations * Update guidelines with C++23 Best Practices book chapters These updates provide comprehensive guidance for AI assistants working with the project while encouraging proper tool usage.
* Add Bloaty.cmake module with comprehensive binary analysis targets * Create per-executable analysis targets and global target * Support CSV reports, baselines, and specialized template analysis * Disable by default since it's not available on all systems * Update AI_GUIDELINES.md with Bloaty usage instructions * Add Bloaty to the list of optional tools in guidelines This helps developers identify binary size issues like template bloat and large static data, which is valuable for performance optimization and embedded systems development.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the project documentation by introducing separate guidelines for human developers and AI agents, ensuring that best practices and strict analysis rules are clearly communicated.
- Adds comprehensive human developer guidelines including C++ best practices, static analysis, and CI/CD setup.
- Introduces AI agent guidelines that outline project configuration, testing workflows, dependency management, and modern C++ standards.
Reviewed Changes
Copilot reviewed 2 out of 9 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| HUMAN_GUIDELINES.md | New human-centric guidelines detailing project purpose, best practices, and tool usage. |
| AI_GUIDELINES.md | New AI-centric guidelines outlining project overview, testing, dependency management, and workflows. |
Files not reviewed (7)
- CMakeLists.txt: Language not supported
- ProjectOptions.cmake: Language not supported
- cmake/Bloaty.cmake: Language not supported
- cmake/Cache.cmake: Language not supported
- cmake/Lizard.cmake: Language not supported
- cmake/Sanitizers.cmake: Language not supported
- cmake/StaticAnalyzers.cmake: Language not supported
| 40:If You Must Do Manual Resource Management, Follow the Rule of 5 | ||
| 41:Don’t Copy and Paste Code | ||
| 42:Prefer std::format, std::print Over iostream Or c-formatting Functions | ||
| 43:constexpr All The Things! (constexpr should be the prefered default as of C++23) |
There was a problem hiding this comment.
Consider correcting 'prefered' to 'preferred' for consistent spelling.
Suggested change
| 43:constexpr All The Things! (constexpr should be the prefered default as of C++23) | |
| 43:constexpr All The Things! (constexpr should be the preferred default as of C++23) |
Copilot uses AI. Check for mistakes.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #112 +/- ##
=======================================
Coverage 20.50% 20.50%
=======================================
Files 5 5
Lines 239 239
Branches 112 87 -25
=======================================
Hits 49 49
- Misses 179 188 +9
+ Partials 11 2 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
lefticus
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.