-
Notifications
You must be signed in to change notification settings - Fork 125
AI coding conventions #173
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.
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
base: develop
Are you sure you want to change the base?
Conversation
cc4d530 to
da5c204
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces AI-specific coding conventions for the PopSift project by creating a comprehensive development guide that establishes consistent standards for AI-assisted code generation. The guide covers C++17 best practices, CUDA development patterns, threading guidelines, and project organization standards.
Key changes:
- Establishes comprehensive coding standards for AI-assisted development covering C++, CUDA, threading, and documentation
- Creates a reference-based system where GitHub Copilot instructions point to the main guide
- Defines consistent naming conventions, error handling patterns, and performance optimization guidelines
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AI_DEVELOPMENT_GUIDE.md | New comprehensive coding standards document covering C++17, CUDA, threading, performance, documentation, and testing guidelines |
| .github/copilot-instructions.md | New minimal reference file directing to the main AI development guide |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
da5c204 to
c041def
Compare
|
I tried to add some more CUDA considerations. |
This is a first draft for the coding convention for the AI agents that may contribute to the code (Copilot, GPT, Claude etc).
The idea is to define the coding rules to follow in the markdown file at the root of the project (well, those should be followed by "human" contributors too :) )
The copilot-guidelines.md simply refer to this one. Like that, other AI can share the same set of rules without repeating them in other files.
Please comment, add, improve :)
PS
Ca va sans dire, it has been generated with the help of ChatGPT :-)