[BUG]: Incorrect parsing of some issues

[drkrillo]

Problem

There are issues that are incorrectly rendered in the README.md (see Evidence section) .
If you check the CSV generated, you'll see that all issues are stored correctly, so probably the issues is in the templating.

Solution

Checking the string of the affected rows in the good_first_issues.csv file would probably give light to what might be happening.
Once identified, probably making a replacement of chraceters will avoid the problem.

Happy to discuss options and thoughts on this one!

Evidence

[Prerana-Sodankoor]

Hi! I'd like to work on this bug. I'll look into the CSV parsing and fix the character replacement in the templating. Please let me know if this is still available.

[drkrillo]

hi @Prerana-Sodankoor !

This is a repo intended to help people onboard on open source. It doesn't really matter if you know a lot of English or not to contribute. I am trying to help real human beings onboard and learn through the process.

Unfortunately, recieving 3 almost simultaneous messages on the issues with the same structure and paraphrasing what the issue body already said, makes me believe that you are farming contributions, without caring much about what the repo is about.

If you are still interested in solving a particular issue, choose one, and try to use your own words to explain it. There is no problem at all with not having the perfect answer right ahead, we can discuss it together and find the best solution.

what do you think?

[Prerana-Sodankoor]

Hi @drkrillo ! I'm sorry about that — I'm completely new to open source and was getting some guidance on how to find and claim issues. I got a bit carried away and didn't think about how it would look. I'm genuinely interested in fixing #91. I understand the bug is about some issues not rendering correctly in the README even though the CSV has the right data, so the problem is likely in the template. I'd love to try fixing it and learn from the process. Can I give it a shot?

[drkrillo]

@Prerana-Sodankoor of course you can :) the issue is yours.

Please have in mind that now the table is rendering properly. That's because I changed the users that the code is gathering the issues from. I think it was pytorch the one that had the issue. Try that one when running the project locally to see if you can catch the bugged one. Even if it's rendering correctly now, catching the edge case can help in the future if another issue happens to have the same structure.

Follow the steps in docs/how-it-works.md to run it.

If you face anyu blockers or you need my help, feel free to ask!

Welcome onboard !

[Prerana-Sodankoor]

Hi @drkrillo ! I ran the project locally with pytorch as the username and managed to reproduce the bug. Issue titles that contain pipe characters | — like [MX | Triton] ... — were breaking the markdown table rendering since | is used to separate table columns. I fixed this by escaping the pipe character in the render_template method in api_handler.py when reading titles from the CSV.
Before I raise a PR to the dev branch, I wanted to check — are there any other special characters you'd like me to handle to make this more robust, or anything else I should look into before submitting? Thank you.

[drkrillo]

Hi @Prerana-Sodankoor !

That makes a lot of sense. That was exactly what we were looking for. Well done spotting it !

I think that for this issue in particular, it is more than enough. Feel free to open a PR directly to main, no need to go through dev.

I'll take a look at it as soon as I can! Thanks for contributing :)

[Prerana-Sodankoor]

Thank you! I really appreciate the guidance and the opportunity to contribute. I learned a lot while debugging and working through the open-source workflow. Looking forward to contributing again in the future.