Skip to content

Suggestion: code and commit guidelines #141

Open
@MikeRomaniuk

Description

@MikeRomaniuk

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions