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

[Doc] : Visual Enhancements , Fostering Contact Channel in README #40

Open
Varunshiyam opened this issue Oct 20, 2024 · 2 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers gssoc-ext GirlScript Summer of Code extended project hacktoberfest Hacktoberfest 2024 event project Level 1 GSSoC project Level 1

Comments

@Varunshiyam
Copy link

Is your feature request related to a problem? Please describe.

Issue Description

Problem: A poorly structured or visually unappealing README can create confusion and hinder user engagement with a project.


This can lead to:

  • Difficulty understanding the project: Newcomers may struggle to grasp

  • Reduced contributions: Potential contributors may be deterred by a lack of clear information

  • Negative first impression: An unprofessional README can reflect poorly on the project and discourage users from
    exploring further.


Describe the solution you'd like

  • To enhance communication and provide direct access to Project Guidance, I plan to include a dedicated Contact section 👤. This section will feature the LinkedIn and GitHub profiles of each mentors and Admin⚡️ enabling contributors to readily connect with them and address any project-related queries.

  • Additionally, to improve readability and organization, I Planned to implement clear visual separations between each section of the contributor documentation, ensuring a user-friendly and easily navigable 🚏 experience.

  • Finally, to foster a welcoming 🙏🏻 and inclusive environment, I will incorporate personalized welcome messages for our Repository.

  • To effectively convey the essence of our project and its objectives, I propose creating a customized cover image for the repository.

  • Kindly Assign me this Issue Under 🌸 Gssoc, ☘️ hacktoberfest . I'm grateful to work with Talented Crews ✨.
@Varunshiyam Varunshiyam changed the title [Doc] : Visual Enhancements , Fostering Contact Channel and enabling Contributors List in README [Doc] : Visual Enhancements , Fostering Contact Channel in README Oct 20, 2024
@Suraj-kumar00
Copy link
Owner

Hi @Varunshiyam, that's amazing!
I'll assing this issue to you but can you show me any sample of preview you have, so that I can also understand what visual enhancement you want to do.

@Suraj-kumar00 Suraj-kumar00 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Hacktoberfest 2024 event project gssoc-ext GirlScript Summer of Code extended project Level 1 GSSoC project Level 1 labels Oct 20, 2024
@Suraj-kumar00
Copy link
Owner

And yeah if you like the project please do consider to give the repo a star 🌟

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 enhancement New feature or request good first issue Good for newcomers gssoc-ext GirlScript Summer of Code extended project hacktoberfest Hacktoberfest 2024 event project Level 1 GSSoC project Level 1
Projects
None yet
Development

No branches or pull requests

2 participants