Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

Add Style Guide and Semver Convention Documentation #80

@JohnnyIrvin

Description

@JohnnyIrvin

Add documentation about style guide and semver convention

Is your documentation request related to a problem? Please describe.
This project is missing a style guide and documentation about its quirks like the semver convention required in commits. Other contributors may have a hard time understanding the project without proper documentation.

Describe the documentation you'd like
A clear and detailed style guide explaining the writing conventions, formatting, and organization of the project's code. Document the semver convention required in commits to avoid PR rejections. The documentation should provide clear examples and explanations so that contributors can easily understand and follow the guidelines.

Describe alternatives you've considered
It's possible to simply provide a brief explanation of the required semver convention in the README file, but a detailed style guide would be more useful for contributors. Without such documentation, contributors may accidentally write code that doesn't meet the project's standards, leading to unnecessary back-and-forth in the PR process.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions