Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize Package.json Scripts #263

Open
jtfairbank opened this issue Dec 6, 2024 · 0 comments
Open

Standardize Package.json Scripts #263

jtfairbank opened this issue Dec 6, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@jtfairbank
Copy link
Contributor

The backend project sets up 3 sets of scripts for various dev commands (e.g. type checking, linting, formatting, etc):

  1. Baseline scripts (e.g. yarn format) to run the command and show the output. These don't change files.
  2. Fix scripts (e.g. yarn format:fix) to run the commands and change files. Note that this won't be relevant for every command, just the ones that can automatically change code.
  3. Check scripts (e.g. yarn check:format) which are what should be used by CI/CD (i.e. githubs automated workflows when you open a new PR). Most of thee time, these are the same as the Baseline scripts, but it's important to keep them separate in case there are different flags needed for local dev vs. the CI/CD pipeline.

Let's standardize the scripts on this project to match the conventions that the backend project is using.

Code:

@jtfairbank jtfairbank added the enhancement New feature or request label Dec 6, 2024
@github-project-automation github-project-automation bot moved this to Triage in DA Tech Dec 6, 2024
@jtfairbank jtfairbank moved this from Triage to Ready for Work in DA Tech Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Ready for Work
Development

No branches or pull requests

1 participant