Skip to content

Conversation

simogasp
Copy link
Member

@simogasp simogasp commented Aug 26, 2025

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 :-)

@simogasp simogasp added this to the v0.10 milestone Aug 26, 2025
@simogasp simogasp requested a review from Copilot August 26, 2025 16:52
Copy link
Contributor

@Copilot Copilot AI left a 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.

@griwodz
Copy link
Member

griwodz commented Sep 1, 2025

I tried to add some more CUDA considerations.

@simogasp simogasp modified the milestones: v0.10, v1.0.0 Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants