yagnik2411 / Quiz-Genius

Introducing Quiz Genius: The ultimate Flutter quiz app with Firebase authentication, dynamic quizzes, real-time feedback, and personalized profiles. Join now to test your knowledge, track progress, and challenge friends. Clone, customize, and conquer quizzes. Start your intellectual adventure today!
https://play.google.com/store/apps/details?id=com.yagnik.quiz_genius
14 stars 26 forks source link

[Documentation] Modification of README.md file & Creation of LICENSE File for project #81

Open rajdeepchakraborty-rc opened 2 hours ago

rajdeepchakraborty-rc commented 2 hours ago

Current Documentation:

1. Modifications in the README.md file:

1) Add animated line separators and add GSSoC 2024 Extended accepted banner

2) Replace the Contact section with a Team section

The present Contact section in the README.md file is not looking attractive: image

3) Updation of the Contributors section

The current Contributors section is the README.md file is not updated to the latest Contributors. I would like to update it and try to automate the process.

2. Addition of a LICENSE File to the project

The presence of a LICENSE file explicitly states the terms under which the code can be used, modified, and shared. If a project does not have a LICENSE file, it implies that the author has not granted any rights to others, and legally, no one has permission to use, distribute, or modify the code.

Proposed Changes:

1. Modifications in the README.md file:

1) Add animated line separators and add GSSoC 2024 Extended accepted banner

I would like to add line separators in the README.md file to separate sections and make the file more readable and attractive. I would also add the GSSoC 2024 Extended accepted image for Contributors to know that this repository is officially accepted for GSSoC contribution.

image

2) Replace the Contact section with a Team section

The present Contact section in the README.md file is not looking attractive: image

The Team section will look more organized and readable and let the Contributors know whom to contact if they face any issues.

image

3) Updation of the Contributors section

The current Contributors section is the README.md file is not updated to the latest Contributors. image

I would like to update it and try to automate the process. image

2. Addition of a LICENSE File to the project

If a project does not have a LICENSE file, it implies that the author has not granted any rights to others, and legally, no one has permission to use, distribute, or modify the code. So, adding a LICENSE file is a best practice for open-source projects. I have added the LICENSE to your project and attached a reference image below to help you review the PR. MIT LICENSE Reference: image

Reasons for Update: The following updates will make the projects more attractive and readable for the Contributors.

Additional Context: N.A.

Assignee: Feel free to assign this issue to me, as I would like to contribute to the documentation improvements.

github-actions[bot] commented 2 hours ago

👋 Hey there, rockstar! Thanks for dropping an issue! The Quiz-Genius team is on it like pineapple on pizza (love it or hate it). Stick around, magic's about to happen!