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: update README.md #404

Merged
merged 7 commits into from
Oct 17, 2024
Merged

docs: update README.md #404

merged 7 commits into from
Oct 17, 2024

Conversation

cin-jimmy
Copy link
Collaborator

Description

  • Reorganized the headings,
  • Proof reading,
  • Add contributions section

Type of change

  • Update README.md (non-breaking change).
  • New features (non-breaking change).
  • Bug fix (non-breaking change).
  • Breaking change (fix or feature that would cause existing functionality not to work as expected).

Checklist

  • I have performed a self-review of my code.
  • I have added thorough tests if it is a core feature.
  • There is a reference to the original bug report and related work.
  • I have commented on my code, particularly in hard-to-understand areas.
  • The feature is well documented.

@cin-jimmy cin-jimmy added the documentation Improvements or additions to documentation label Oct 17, 2024
Copy link
Collaborator

@taprosoft taprosoft left a comment

Choose a reason for hiding this comment

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

LGTM

@taprosoft taprosoft merged commit 2bc1b01 into main Oct 17, 2024
8 checks passed
@taprosoft taprosoft deleted the docs/update-readme branch October 17, 2024 08:41
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants