search

Omkar-Sonawane-23 / Maa-Vimala

https://maa-vimala.vercel.app
67 stars 126 forks source link

A better ReadMe File for the Repo #36

Open nishantharkut opened 1 month ago

nishantharkut commented 1 month ago

Is your feature request related to a problem? Please describe. The Current Readme file is not giving an apt idea of the project. Also, the UI and Design of the Readme is not Good.

Describe the solution you'd like I will make a design friendly and user friendly Readme Area for users to easily know about the repo and help for the PRs

Omkar-Sonawane-23 commented 1 month ago

@nishantharkut You Can Start Working On this Project.

SanjanaBankar commented 1 month ago

Hello,

Is your feature request related to a problem? Please describe. After reviewing the current README, there's significant room for improvement to make it more engaging, informative, and user-friendly. By restructuring content, adding visuals, and emphasizing engagement, we can better communicate the project's value.

Describe the solution you'd like Clear headings, concise descriptions, and visually appealing formatting will enhance readability and comprehension. Including clear instructions on how to contribute, report issues, or provide feedback. Incorporating relevant visual assets such as images, diagrams, or even GIFs can effectively showcase the interface and functionality of Maa-Vimala

I'm eager to take on this task and work closely with the team to implement these enhancements.

anythingkartik commented 1 month ago

Hi, I'm Kartik, and I'm new to open source and I would love to start my journey by working on making a better ReadMe File Please consider assigning me this issue. I'm looking forward to adding my touch to the project. Here's my LinkedIn profile for further contact: https://www.linkedin.com/in/itskartikgupta/

ghost commented 1 month ago

please assign me this issue

kavyagupta3011 commented 1 month ago

Could you please assign this issue to me? I can add essential steps like:

prerequisites: git and a modern web browser installation steps: Clone the repository git clone https://github.com/Web403/Maa-Vimala.git Navigate to the project directory cd Maa-Vimala Open the index.html file in your preferred web browser Contributing: Read the Contribute.md file in the repository. Open an issue to discuss major changes or features you'd like to work on. Fork and clone the repository. Make your changes in a new branch. Submit a pull request.

Such steps are essential to write for newbies to open source, and I would be happy to contribute. Could you assign this to me under the appropriate labels ?

mohangolakoti commented 1 month ago

Issue Solved Check PR - #156