Skip to content

Update DXC's CONTRIBUTING file #7265

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

Merged
merged 3 commits into from
Apr 3, 2025

Conversation

llvm-beanz
Copy link
Collaborator

This change seeks to address some recent questions about how the LLLVM Coding Standards are applied in DXC.

This change seeks to address some recent questions about how the LLLVM
Coding Standards are applied in DXC.
damyanp
damyanp previously approved these changes Mar 26, 2025
Copy link
Member

@damyanp damyanp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have a link to the LLVM coding standards from here as well?

bob80905
bob80905 previously approved these changes Mar 26, 2025
@llvm-beanz
Copy link
Collaborator Author

Should we have a link to the LLVM coding standards from here as well?

There was a broken link in the docs a few lines above (DXC has always referred to the LLVM Coding Standards in its CONTRIBUTING file). I fixed that link. Do you think it warrants a second link, or is the one in the first sentence of the containing section sufficient?

Co-authored-by: Ashley Coleman <ascoleman@microsoft.com>
@damyanp
Copy link
Member

damyanp commented Mar 26, 2025

There was a broken link in the docs a few lines above (DXC has always referred to the LLVM Coding Standards in its CONTRIBUTING file). I fixed that link. Do you think it warrants a second link, or is the one in the first sentence of the containing section sufficient?

Oh, I missed that - I was looking for a link to https://llvm.org/... so didn't spot the link to a local file. If the contents of the linked file is correct then I don't think we need another one.

@llvm-beanz
Copy link
Collaborator Author

If the contents of the linked file is correct then I don't think we need another one.

I think they're correct enough. While the LLVM coding standards have evolved over the ~10 years since DXC forked, the core of the standards have remained largely the same. If we encounter issues where the DXC document is inappropriately stale I'd suggest we update it.

@llvm-beanz llvm-beanz dismissed stale reviews from bob80905 and damyanp via 99ff6dc March 31, 2025 22:37
@llvm-beanz llvm-beanz merged commit 6a73640 into microsoft:main Apr 3, 2025
12 checks passed
@llvm-beanz llvm-beanz deleted the cbieneman/update-contributing branch April 3, 2025 13:56
@github-project-automation github-project-automation bot moved this from New to Done in HLSL Roadmap Apr 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

9 participants