Open
Conversation
cc4d530 to
da5c204
Compare
Contributor
There was a problem hiding this comment.
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
Member
|
I tried to add some more CUDA considerations. |
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
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.
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 :-)