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

[docs] Improving and Styling main README file #34

Open
5 tasks done
Avdhesh-Varshney opened this issue Jan 6, 2024 · 2 comments
Open
5 tasks done

[docs] Improving and Styling main README file #34

Avdhesh-Varshney opened this issue Jan 6, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation SWOC S4

Comments

@Avdhesh-Varshney
Copy link
Contributor

Category of documentation update

I would like to improve the main readme file and design to showcase the project.

  • Add details of
    • LICENCE,
    • CODE OF CONDUCT,
    • CONTRIBUTION GUIDELINES,
    • Tags related to,
      • REPO SIZE,
      • TECH USED,
      • NO. OF ISSUES and PR's
    • PROJECT ADMIN,
    • BACK TO TOP BUTTON, etc.

All these makes the readme file more attractive.

Describe the change you think might work

This will makes REAMDE file,

  • more readable.
  • attract the attention of users to the details of Project.

Checklist

  • I have checked the existing issues
  • I have read the Contributing Guidelines
  • I am willing to work on this issue (optional)
  • I am a SWOC'24 contributor

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Avdhesh-Varshney Avdhesh-Varshney added the documentation Improvements or additions to documentation label Jan 6, 2024
@Avdhesh-Varshney
Copy link
Contributor Author

@pinak22dhir please assign this task to me under SWOC'24

@shubha987
Copy link

shubha987 commented Jan 7, 2024

@pinak-dhir hey, please assign me the issue for the documentation i can add all of that
Screenshot 2024-01-07 203300
Screenshot 2023-12-12 221805

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 SWOC S4
Projects
None yet
Development

No branches or pull requests

3 participants