jacob-macleod/Dolphin-Flashcard-App

Add Style Checking for React in CI/CD Pipeline

Open

#164 opened on Sep 16, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (31 forks)auto 404
DevOpsgood first issue

Repository metrics

Stars
 (18 stars)
PR merge metrics
 (PR metrics pending)

Description

For python, pylint is run in the pipeline to make sure the code adheres to PEP8 standards. If it does not, black can be run manually to make it conform by formatting the files. Your task is to:

  • Find equivalent tools for the React code
  • Implement the equivalent of Pylint but for React in the pipeline
  • Find a formatter (like black, but for React, following React standards), and manually run it on the React code in the frontend folder

Let me know if you have any questions or want any more information!

Contributor guide

Research direction
Identify React equivalent tools for Python's pylint and black, such as ESLint for linting and Prettier for formatting. Then add a step in the CI/CD pipeline (e.g., GitHub Actions) to run ESLint on the frontend code. Finally, manually run Prettier on the existing React code in the frontend folder.
Tech stack
reactjavascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60