search

rahulharpal1603 / CF-TopHacker

Chrome extension for displaying Hacks leaderboard on CF.
https://chromewebstore.google.com/detail/cf-tophacker/jjonaiodlgelhegbbihodicniiccbhbi
3 stars 7 forks source link

Add description and Features to README for Better Contributor Guidance #10

Open RaginiSharma01 opened 4 hours ago

RaginiSharma01 commented 4 hours ago

Hi there! 👋

I noticed that the current README lacks some key details that could help new contributors get up to speed quickly. Specifically, it would be really helpful to:

List the technologies (tech stack) used in the project, so contributors know which languages, frameworks, or tools are involved. Provide a brief section outlining the main features of the project. This would give contributors a clear understanding of what the project is about and what features are already implemented or need improvement.

RaginiSharma01 commented 4 hours ago

Assign this task to me I would improve the readme documentation for better user understanding

rahulharpal1603 commented 4 hours ago

Can you also make a CONTRIBUTION.md file? Stating all the guidelines like setup instructions for the project.

RaginiSharma01 commented 4 hours ago

Can you also make a CONTRIBUTION.md file? Stating all the guidelines like setup instructions for the project.

Yes I can do it

rahulharpal1603 commented 3 hours ago

Ok, I am assigning this issue.