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

[Documentation Bug]: Missing Project Description and Potential README Improvements #144

Closed
1 task done
Nidhi1314 opened this issue Jun 13, 2024 · 3 comments · Fixed by #182
Closed
1 task done
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers gssoc level1

Comments

@Nidhi1314
Copy link
Contributor

Nidhi1314 commented Jun 13, 2024

Describe the bug ✍️

Missing Project Description:

The current README file lacks a clear description of what Squard-line is and what it does.
Including a concise yet informative description would be beneficial for potential contributors and users who want to understand the project at a glance.

Potential Improvements:

  • Contribution Guidelines: In the "How to make a PR in a Project" section, a sentence at the beginning could clarify what kind of contributions are welcome (e.g. bug fixes, new features, documentation improvements).
  • Badges: The generic badges like "Built with love" could be replaced with more specific ones reflecting the technologies used (e.g. programming languages, frameworks).

Provide step by step information reproduce the bug 📄

Proposed Action:

  • I can draft a clear and concise project description based on the available information and update the contribution guidelines and badges section as stated above.

Please let me know if you'd like me to proceed with changes in Readme

Select program in which you are contributing

GSSoC24

Code of Conduct

Copy link

Hey @Nidhi1314! 👋

👉 Thanks for opening this issue. We appreciate your contribution and will look into it as soon as possible.
👉 Don’t forget to star our Squard-line and Follow Us on GitHub
👉 Make sure you join our Discord, we have created separate channels for all projects

@github-actions github-actions bot added the gssoc label Jun 13, 2024
@Mukesh751
Copy link
Collaborator

@Nidhi1314 go ahead

@Mukesh751 Mukesh751 added documentation Improvements or additions to documentation good first issue Good for newcomers level1 labels Jul 25, 2024
@Nidhi1314 Nidhi1314 mentioned this issue Jul 26, 2024
6 tasks
Copy link

github-actions bot commented Aug 6, 2024

Thank you for your contribution! If you have any questions or need further assistance, feel free to reach out to us on our Discord server: Discord. We have separate channels for all projects. Happy coding! 🚀

Connect with us on social media:

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 good first issue Good for newcomers gssoc level1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants