Skip to content

Add some style guide verbiage#63

Merged
derobins merged 7 commits into
developfrom
derobins/style_guide_start
Nov 19, 2025
Merged

Add some style guide verbiage#63
derobins merged 7 commits into
developfrom
derobins/style_guide_start

Conversation

@derobins
Copy link
Copy Markdown
Collaborator

  • Headers
  • C/C++ standards
  • A few misc other things

* Headers
* C/C++ standards
* A few misc other things
Copy link
Copy Markdown
Contributor

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 adds essential style guide documentation to the project, establishing coding standards and conventions for the hipFile/rocFile codebase. The changes fill in previously empty sections with concrete guidelines for headers, language features, and shell scripts.

Key changes:

  • Added header organization guidelines (include-what-you-use, #pragma once, header ordering, Doxygen requirements)
  • Specified C++17 and C11 language standards with modern idiom requirements
  • Added shell script standards (shellcheck, bash shebang, bash-isms)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread STYLEGUIDE.md Outdated
Copilot AI review requested due to automatic review settings November 18, 2025 23:39
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread STYLEGUIDE.md
Copilot AI review requested due to automatic review settings November 19, 2025 00:57
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread STYLEGUIDE.md Outdated
Comment thread STYLEGUIDE.md
@derobins derobins merged commit feab178 into develop Nov 19, 2025
7 checks passed
@derobins derobins deleted the derobins/style_guide_start branch November 19, 2025 16:31
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.

3 participants