Skip to content

Comments

Improve README documentation and formatting#234

Open
Sukhmanpreetkaur18 wants to merge 3 commits intosaurabh-dev-vns:mainfrom
Sukhmanpreetkaur18:main
Open

Improve README documentation and formatting#234
Sukhmanpreetkaur18 wants to merge 3 commits intosaurabh-dev-vns:mainfrom
Sukhmanpreetkaur18:main

Conversation

@Sukhmanpreetkaur18
Copy link

@Sukhmanpreetkaur18 Sukhmanpreetkaur18 commented Jan 20, 2026

Related Issue

Fixes #233

Description

This pull request improves the README documentation by adding a beginner-friendly section and improving clarity for new contributors.

Summary

Improved the README by adding a clear Contributing section and a beginner-friendly note.

Changes

  • Added step-by-step contribution guidelines
  • Improved readability and structure of README

Type of change

  • Documentation update

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Other (specify): _______________

Screenshots / videos (if applicable)

N/A

Checklist:

  • I have made this change from my own.
  • I have taken help from some online resources.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers and screenshots after making the changes.

@github-actions
Copy link

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@Sukhmanpreetkaur18
Copy link
Author

hi @saurabh-dev-vns please merge it.

@Sukhmanpreetkaur18
Copy link
Author

Sukhmanpreetkaur18 commented Jan 26, 2026

Hi @saurabh-dev-vns ,
I've updated the README with clearer contributing guidelines and improved formatting.
Please let me know if any additional changes are needed. Thanks!

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.

Improve README documentation and formatting

1 participant