AOSSIE-Org / AOSSIE-Org/EduAid
[BUG]: README backend setup instructions are incomplete and minor code hygiene issues exist
- Lenguaje dominante
- JavaScript
- Estrellas
- 171
- Forks
- 423
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### 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
### Environment Details
_No response_
### Impact
Low - Minor inconvenience
### Code of Conduct
- [x] I have joined the [Discord server](https://discord.gg/hjUhu33uAn) and will post updates there
- [x] I have searched existing issues to avoid duplicates
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Evaluación
Este issue todavía no se ha evaluado.