Skip to content
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

Suggestion: code and commit guidelines #141

Open
MikeRomaniuk opened this issue Feb 3, 2025 · 2 comments
Open

Suggestion: code and commit guidelines #141

MikeRomaniuk opened this issue Feb 3, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@MikeRomaniuk
Copy link

Hey there!

I wanted to bring up the idea of establishing clear and consistent style guidelines for both codebase and commit messages. As I see it, this repository has great potential, and maintaining a unified style will go a long way in ensuring the quality, readability, and maintainability of our code as the project grows.

For the code itself, I think it would be helpful to introduce a dedicated .md file. A great example of what I have in mind can be seen in the CONTRIBUTING.md from cloud-hypervisor or STYLE.md from IronRDP.

The same for commit messages. I'm inclined towards following the unified style outlined in the Conventional Commits specification.

I’d love to hear your thoughts on this and see if we can move forward with setting something up!

@MikeRomaniuk
Copy link
Author

Update: CONTRIBUTING.md already exists in the rust-gpu repo, so there are no excuses to not do this in this project.

@LegNeato LegNeato added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Mar 7, 2025
@LegNeato
Copy link
Contributor

LegNeato commented Mar 7, 2025

SGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants