ChicoState / ChicoState/djsongmatch

As a developer, I want code linting checks

Open
#89 0 comments 0 reactions 1 assignee Claimed by @madisonewebb View on GitHub
enhancement
Dominant language
Jupyter Notebook
Stars
8
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### Requests

- Personally, I dislike the idea of mandating linting before _every_ push to a **feature branch** because I worry it could negatively impact development speed (sometimes people want to test out stuff without worrying about being perfect)
- However, we should definitely implement linting checks **before a PR could be merged into main** so that our main stays clean

### Linting Tool Recommendations

##### NextJS/frontend

- For NextJS, I really recommend `eslint` as a static linting tool.
- It's pretty much the standard for linting JS/TS
- NextJS has strong support for it
- It's already defined in our `package.json`. All we have to do to lint our frontend code is run `pnpm lint` or `pnpm next lint` (same thing) and it will provide helpful things it catches

##### Python/backend

- I am not familiar with the standard linting tools for Python. Since @riley-1995 works heavily on the Python side, I feel like we should pick a linter that shares her and other devs who work on backend's opinions

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.