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

docs: enhance README with comprehensive contribution guidelines #51

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

crStiv
Copy link

@crStiv crStiv commented Feb 23, 2025

Improve README.md documentation with the following changes:

  • Add detailed installation instructions for different OS
  • Include comprehensive contributing guidelines
  • Add commit message format requirements
  • Improve overall document structure and readability
  • Add testing instructions
  • Include license and contact information

This update makes the documentation more accessible for new contributors
and provides clear guidelines for participation in the project.

@crStiv crStiv requested a review from fcasal as a code owner February 23, 2025 15:48
@CLAassistant
Copy link

CLAassistant commented Feb 23, 2025

CLA assistant check
All committers have signed the CLA.

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.

2 participants