DOC: Modification of README.md file(Design), & Creation of dedicated Contributing.md file and LICENSE.

[rajdeepchakraborty-rc]

What's wrong with the existing documentation

Proposed Solution

1. Modifications in README.md file

1) Add animated line separators

This will make the README.md file look more attractive and engaging for the Users and Contributors

2) Modifiy the Contributors section.

I noticed that you are manually adding the contributors to your project. I want to try and automate the process to reduce your workload.
NOTE: However, let me mention that the looks will change(screenshot attached below).

3) Add a Team section

This will help the Contributors know about the Project Admin and who to contact if they face any issues.

2. Add a dedicated Contributing.md

A dedicated file for contributors to refer to and understand where to begin with. Merging the README.md with the Contributing section reflects poor documentation style. I will provide a brief idea about the contribution in the README.md file and provide a redirect to the newly made Contributing.md file for contributors to refer to.
I would also add a redirect to Contributing.md from README.md

3. Add MIT LICENSE

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.
So, adding a LICENSE file is a best practice for open-source projects.

I would like to work on the issues so that I can contribute to making the repository more accessible and friendly for other Contributors.
Please assign this issue to me under level3, gssoc-ext and hacktoberfest-accepted(if available) labels.

Add ScreenShots

1. Modifications in README.md file

1) Add animated line separators

2) Modifiy the Contributors section.

• Before

This is taking up a lot of space and resulting in unnecessary scrolling in the README.md file.

• After

This will give a neat outlook and also enhance the readability of the README.md file.

3) Add a Team section

2. Add a dedicated Contributing.md

Reference file image:

3. Add MIT LICENSE

Record

• I agree to follow this project's Code of Conduct
• I'm a GSSOC'24 contributor
• I want to work on this issue

[github-actions]

Thank you for creating this issue! 🎉 Your issue will soon be reviewed by either the PA or a mentor. Please note that Level 1 is temporary and can be changed during the review. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.

[github-actions]

Thanks for creating the issue in BuddyTrail!
Before you start working on your PR, please make sure to:

• ⭐ Star the repository if you haven't already.
• Pull the latest changes to avoid any merge conflicts.
• Attach before & after screenshots in your PR for clarity.
• Include the issue number in your PR description for better tracking.
  Don't forget to follow @PriyaGhosal – Project Admin – for more updates!

We're excited to see your contribution as part of GSSOC Extended Edition 2024 and Hacktoberfest! 🎉
Happy open-source contributing!

[rajdeepchakraborty-rc]

@PriyaGhosal I also noticed while working that you don't have a LICENSE for your project. Do you want me to add it to my issue and work on it since I am working on updating the documentation of the project? Since this is an open-source project, it should have a LICENSE in it.

[rajdeepchakraborty-rc]

@PriyaGhosal Please do let me know.

[rajdeepchakraborty-rc]

@PriyaGhosal wanted to update you regarding the work. I have successfully automated the process of adding the contributors in your README.md file. You no more have to manually add the Contributors(reflecting poor documentation practice).

[rajdeepchakraborty-rc]

@PriyaGhosal wanted to update you regarding the work. I have successfully automated the process of adding the contributors in your README.md file. You no more have to manually add the Contributors(reflecting poor documentation practice).

This will update automatically!

[rajdeepchakraborty-rc]

I have also updated the bottom section of the README.md file and added the Team Section. Here is how it looks:

[rajdeepchakraborty-rc]

@PriyaGhosal I also noticed while working that you don't have a LICENSE for your project. Do you want me to add it to my issue and work on it since I am working on updating the documentation of the project? Since this is an open-source project, it should have a LICENSE in it.

@PriyaGhosal Please update me regarding this so that I can either add it and open a PR.

[rajdeepchakraborty-rc]

Thank you for creating this issue! 🎉 Your issue will soon be reviewed by either the PA or a mentor. Please note that Level 1 is temporary and can be changed during the review. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.

I just noticed this message. Sadly there was not such file in the project before. But after I merge it, please update this and provide a redirect to it.

[PriyaGhosal]

@rajdeepchakraborty-rc Sorry for the inconvenience caused You can surely add license .. Create new pr I will surely merge it ......You have done great job :)

[rajdeepchakraborty-rc]

@PriyaGhosal I have not yet created the PR was waiting for you response

[rajdeepchakraborty-rc]

I am done with most of the work. Just adding the LICENSE is left. Will add that and open a PR and let you know.

[rajdeepchakraborty-rc]

@rajdeepchakraborty-rc Sorry for the inconvenience caused You can surely add license .. Create new pr I will surely merge it ......You have done great job :)

Thanks for the appreciation.

[PriyaGhosal]

@rajdeepchakraborty-rc You need not to ask me .... Any contributor is free to raise issue and create PR ..... Thank You for your Patience

[rajdeepchakraborty-rc]

@rajdeepchakraborty-rc You need not to ask me .... Any contributor is free to raise issue and create PR ..... Thank You for your Patience

Please try to visit the issues once in a while as Contributors might wanna ask you doubts or share any feedback with you.

[rajdeepchakraborty-rc]

@rajdeepchakraborty-rc You need not to ask me .... Any contributor is free to raise issue and create PR ..... Thank You for your Patience

Since I am working in your project, I must ethically let you know about any changes I am making. I was just doing that. Thanks for your reply.

[rajdeepchakraborty-rc]

@PriyaGhosal Please let me know once you are done merging because I am constantly getting conflicts. I will resolve the conflicts once you are done merging PRs.

[rajdeepchakraborty-rc]

@PriyaGhosal Also Please do not add Contributors manually anymore. I don't know who is adding them. Please tell that person to stop as I have automated the process. The entire reason I worked for so long was so that you don't have to keep track manually of the contributors anymore and rather focus on spending time on issues and PR reviews.

[github-actions]

Hello @rajdeepchakraborty-rc! Your issue #311 has been closed. Thank you for your contribution!

[rajdeepchakraborty-rc]

@PriyaGhosal Please update the level to level2