Skip to content

[BUG]: README backend setup instructions are incomplete and minor code hygiene issues exist #424

@HamidKhan1001

Description

@HamidKhan1001

Bug Description

While setting up and running the backend, I noticed a couple of small issues that affect contributor experience and code cleanliness:

README backend instructions

Python version requirements are not explicitly stated

The correct working directory (backend/) is not clearly emphasized

A missing closing code block breaks markdown rendering for sections below

Duplicate imports in backend code

Some backend files contain repeated import statements

This does not break functionality but affects readability and maintainability

These are non-functional issues. I can submit a single PR addressing both if that works.

Scope:

README.md

Backend Python files (duplicate imports only)

Details

README issues

The backend run instructions do not clearly specify the required Python version.

The working directory (backend/) is not explicitly stated in all places.

A missing closing triple backtick breaks Markdown rendering for all sections below it on GitHub.

Code issues

Duplicate imports from transformers are present.

The re module is imported more than once.

These issues do not affect runtime behavior directly but reduce readability and make local setup confusing for new contributors.

Steps to Reproduce

No response

Logs and Screenshots

Image

Environment Details

No response

Impact

Low - Minor inconvenience

Code of Conduct

  • I have joined the Discord server and will post updates there
  • I have searched existing issues to avoid duplicates

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions