[DOCS] Reduce duplicated onboarding instructions between README.md and CONTRIBUTING.md

[niy-ati]

Description

Problem

The repository currently contains largely overlapping onboarding and contribution instructions in both README.md and CONTRIBUTING.md.

Both files describe the same contribution workflow, including:

Forking the repository
Cloning the fork
Creating a branch
Adding a contributor entry
Committing changes
Pushing changes
Creating a Pull Request

Because the same instructions are maintained in multiple locations, future updates may need to be applied in more than one file. This increases the likelihood of documentation drift where one guide becomes outdated while the other remains updated.

Why this matters

Increases documentation maintenance effort.
Creates risk of inconsistent contributor instructions.
Makes future updates harder to manage.
Can confuse first-time contributors if the guides diverge over time.

Suggested Direction

Consider keeping detailed contribution instructions in a single source of truth (for example, CONTRIBUTING.md) and linking to it from README.md, or clearly separating the purpose of each document to minimize duplicated content.

References

README.md
CONTRIBUTING.md

[github-actions]

👋 Welcome to Good First Issue!

Thank you for opening your first issue! We're excited to help you on your open source journey.

A maintainer will review your issue soon. In the meantime:

• Make sure you've provided enough detail about your question or problem
• Join our community and connect with other contributors!

We're here to help! 🎉

[niy-ati]

@Adez017 kindly assign this to me ,
Proposed Approach:

I plan to review the overlapping onboarding content in both README.md and CONTRIBUTING.md and identify sections that provide the same instructions.

The goal is to reduce duplication while preserving the beginner-friendly experience of the repository. Rather than maintaining identical contribution workflows in multiple files, I would:

1. Compare both documents and identify duplicated sections.
2. Determine which document should serve as the primary source for detailed contribution instructions.
3. Replace redundant content with concise references or links where appropriate.
4. Ensure that all contribution steps remain easily accessible for first-time contributors.
5. Verify that navigation between documentation files remains clear and intuitive.

This approach aims to improve maintainability, reduce the risk of documentation drift, and keep contributor guidance consistent across the repository.

suggested lables:

NSOC'26
LEVEL

[Adez017]

@niy-ati the readme had a quick gist as per the common open source best practices and contributing is a dedicated files , like usually open source project do . i don't think this would be relevent . can we had something else on this place ?

[niy-ati]

@Adez017 ,Thank you for the feedback.

I agree that having a concise overview in README.md and a dedicated CONTRIBUTING.md aligns with common open-source practices. My original concern was less about the existence of both files and more about ensuring that contributor onboarding information remains consistent as the repository evolves.
Instead of removing content from either document, a possible direction could be to further clarify the responsibility of each file:

• README.md as the high-level project entry point and onboarding overview.
• CONTRIBUTING.md as the authoritative contribution guide.
• QUICKSTART.md as the detailed step-by-step walkthrough for first-time contributors.

This would preserve the current structure while making it easier to maintain consistency when onboarding instructions change in the future.I'm happy to adjust the scope of this issue accordingly if that aligns better with the project's goals.