oss-slu / esp

MIT License
0 stars 9 forks source link

Add frontend and backend linting GitHub Actions (#79) fixes #87

Closed mkalal6 closed 1 month ago

mkalal6 commented 1 month ago

Fixes #79

What was changed?

Created eslint.yml and pylint.yml Two GitHub Actions workflow files were added: one for the frontend (React.js) using ESLint and another for the backend (Python Flask) using Pylint. A .prettierrc.json file was also added to enforce consistent code formatting rules across the project. The pylint.yml file has been commented out but is in place for future use.

Why was it changed?

The project previously lacked automated linting for both the frontend and backend codebases. This absence of linting could lead to inconsistent code styles and errors potentially slipping through during code reviews. Adding these linting workflows ensures that code style is consistently enforced and errors are caught early in the development process. It addresses the need for automated, continuous code quality checks across both parts of the codebase, improving the overall maintainability and quality of the project.

How was it changed?

*eslint.yml: A new workflow file was added for the frontend codebase (React.js). This file configures GitHub Actions to automatically run ESLint on all JavaScript (.js) and JSX (.jsx) files in the frontend directory.

pylint.yml: Although commented out for now, this file was created for Python (Flask) backend linting. It configures GitHub Actions to run Pylint on all Python files (.py) in the backend directory, ensuring adherence to the project's coding standards. It's not yet activated, but it's ready to be used when needed.

.prettierrc.json: A configuration file for Prettier was added to ensure consistent code formatting across the project. This will automatically format code, reducing style inconsistencies, especially in the frontend.*