Existing README:

• Project statistics (stars, forks, issues, pull requests) are included but not well-integrated.
• Contributors are mentioned briefly at the end.
• The existing README has visual elements such as badges and tables, but they are not effectively integrated to enhance readability.
• The participation in events like GirlScript Summer of Code is mentioned but not detailed.
• The structure of the existing README is somewhat scattered, with various sections and acknowledgements not clearly separated or organized.
  this are the issue that i solved in my pull request

Issue templates are very helpful for a collaboration repo. When users identify a bug or want to add a new feature, you can provide templates so you can collect all the pertinent information you need to fix a bug or add a new feature.

We recommend creating a “Report Bug” and “Feature Request” issue template.
you can refer this: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Some suggested prompts/questions you can add to a “Report Bug” template are:

Briefly describe the bug
What is the expected behavior?
Please provide step by step instructions on how to reproduce the bug
Some suggested prompts/questions you can add to a “Feature Request” issue template are:

Briefly describe your feature request
What problem is this feature trying to solve?
How do we know when the feature is complete?

Reference: https://github.com/Recode-Hive/Stackoverflow-Analysis/issues/new/choose
Click on Get Started button and copy the template to yours.

👋 Hi @AryaChakraborty ,

I am Prince,web developer Girlscript Summer of Code. I'll be collaborating with you on preparing your repo for GSSoC'24 Program

Why are these changes required?
After Analysing last year's contributions and feedback it would be great for students to have a couple of standard readme files on the repo to understand what the project is all about and some issues detailing what they can contribute. This will help you to see increased engagement in your repository as well.

As mentioned students get a chance to learn step by step, how to build this project as well as invite mentors to collaborate and add features to this repo. I will generate issues, which will provide guidance on how to prepare your repo for Girlscript summer of code 2024 on 10th May.

This issue will serve as a tracking issue to track all issues related to GSSoC'24. I recommend creating a new branch for every issue and opening a pull request to track changes so we can effectively collaborate with each other and merge changes when you and I feel like those changes are ready to be merged on your primary branch.

If you have any questions or concerns, please feel free to leave a comment on this issue or any of the other issues that are generated.

I look forward to working with you

• #1
• #2
• #3
• #4
• #5

Describe the feature

missing Installation steps in readme.md file.
i will add how to install the project in the local system and how to clone it

Implement features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project and that contributions are welcome :)

Write Documentation

We can always use more documentation on the web in blog posts, articles, and such.

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context

Add any other context about the problem here.

The repository currently lacks a CONTRIBUTING.md file, which is an important resource for guiding potential contributors on how to engage with the project effectively. A CONTRIBUTING.md file outlines the contribution guidelines, coding standards, and procedures for submitting pull requests, thus streamlining the contribution process and ensuring consistency across contributions.

Could you please assign this issue to me under GSSOC 24.

I would like to try and work on different techniques to increase the efficiency of responses from the model. Please assign this to me.

#3

• Chrome

• Error : 404 Page not found

As the instructions to contribute using GitHub Desktop are missing in the current Contributing.md file, I would like to add those detailed instructions.

I believe that by providing clear and comprehensive guidance, we can encourage more contributors to participate in the project, especially those who prefer using GitHub Desktop for their contributions.

Could you please assign me the issue related to adding GitHub Desktop contribution instructions under gssoc24? I am excited about the opportunity to contribute to the project and help streamline the contribution process for others.

Creating a pull request template for the project to make this repository suitable for Github community standards.

What will it have ?

1. Brief Description
2. Issue it addresses or closes
3. Checklist for (tested locally, necessary documentation , etc.)
4. Screenshots and Additional notes

Plz Assign it to me under gssoc 24 contributor

Learn repos should have a LEARN.md file to teach student how to build your project step by step. You can explain how to build your project with text, code snippets, images, or even short (5 minute) long video lessons. As the maintainer of a Learn repo, the LEARN.md file requires you to think critically about how to explain the building of your project and how to also make it engaging. We don't expect you to be an expert teacher, but we would like you to reflect on how difficult it was to get to your level of knowledge, and then provide friendly guidance to help other students to learn.

Reference: https://github.com/Recode-Hive/Stackoverflow-Analysis/blob/main/Learn.md

I would like to add a pull request template for this repository. I believe that having a standardized template will help streamline the contribution process, ensuring that all necessary information is included and making it easier for maintainers to review and merge pull requests.

Could you please assign this issue to me under GSSOC'24.

This app can make use of ranking algorithms

The README.md could be better. It could be rewritten in proper markdown format along with details on how to clone the project and how to contribute to the project.

Making a gradio web app which provide the functionality to access it via api call and deploy it on the huggingface hub spaces which is open source. It provides v2 16 gb cpu for free use

Implement features

• Making gradio web app which can be deployed further on huggingface hub space very easily and can be accessed freely.
• Gradio web app will allows us to access the app via API call to the endpoint.
• Frontend of the project can be hosted on vercel and ML models can be accessed by api call from gradio seamlessly.

Additional context

I've previously deployed my gradio web app for my project of Dark Pattern Detection which uses a fine tuned BERT model for multi class classification of dark pattern categories .
Link : https://huggingface.co/spaces/4darsh-Dev/dark_pattern_detector_app_v2

Users will be able to ask questions or upload files of their choice for context in Indian regional languages. Further, the response they get will also be in the input language thus making it more accessible for the user.

I would like to work on this functionality under GSSoC'24.

We recommend that every repo has a code of conduct. If you don’t feel comfortable creating your own Code of Conduct from scratch we highly recommend using one of the templates provided by GitHub. If you do use a template, please read through the template and ensure that you can and will abide by the Code of Conduct.

Please follow these instructions on how to add a Code of Conduct.

Sample: https://github.com/Recode-Hive/Stackoverflow-Analysis/blob/main/CODE_OF_CONDUCT.md

I am interested in contributing to the project by adding detailed instructions on how to contribute using GitHub Desktop.

I believe that by providing clear and comprehensive guidance, we can encourage more contributors to participate in the project, especially those who prefer using GitHub Desktop for their contributions.

Could you please assign me the issue related to adding GitHub Desktop contribution instructions under gssoc24? I am excited about the opportunity to contribute to the project and help streamline the contribution process for others.

As the maintainer of a Collaborate repo, keeping Issues up-to-date will help the student community understand what they can do to contribute. Issues should vary by the easy (update documentation) to the difficult (add a new feature). The more involved you are, the more opportunities there are to collaborate.

Recommendations:

Add issues of varying difficulty to the repo often. you must add the tag GSSoC'24, Level 1, Level2, Level 3 good first issue etc.
How we cacluclate the Scores on Leaderboard: Every PR one point
Level 1: 10 points
Level 2: 25 points
Level 3: 45 points
Try to add some documentation issues as well it would be easy for beginner contributor to explore opensource through your repo.
Generate issues even if you plan on solving them, so the repository appears as active.
Contribute/commit often to the repo so it does not go stale.
Reference https://github.com/Recode-Hive/Stackoverflow-Analysis/issues

By this issue, I propose to add a Dockerfile to the repository. This will enable users to easily build and run the project in a containerized environment, improving portability and reproducibility.

Please assign this issue to me.

In GSSoC'24, GitHub Topics will help the discoverability of your project.

I see that you already have great topics on your repository!
I would recommend adding the name of the company like the software you use to build like "vs-code, ghdesktop" to improve your discoverability.

If you are happy with the topics you have, feel free to close this issue. 👍

Describe the bug

While installing the packages from requirements.txt many files create dependency issues and I have noticed most of them are not even the required packages for running the project.

If you are reporting a bug, please include:

• My operating system is Windows 10
• I tried setting up the file in a conda environment but the file already contains conda packages. So please keep that in mind while contributing to this issue
• For your reference here is the bug I am talking about:
  

Hey @AryaChakraborty,
I found several typos.
Fox ex:- src/llms/azurechat.py line 62 AI assitant should be AI assistant

Assign this to me, I would like to fix them. Kindly add the GSSOC'24 label and level.

Hey @AryaChakraborty the readme file can be more enhanced and updated , adding more features , guidelines . As Readme file plays an important role in user/Contributor convenience .
Kindly assign this issue to me under GSSoC'24 .