Linting an Application

Owned by Mikah Pinegar
Jan 09, 2023
1 min read

Introduction

When linting a legacy application, this document will help to make reviewing the code easier

Order of Operations

  1. Add your lint config file. For JavaScript, this can be used as a starting point https://github.com/precision-sustainable-ag/dst-selector/blob/develop/.eslintrc.json

  2. Make a new branch called feature/final-linted or something similar based off of develop

  3. Make a PR with auto lint changes into feature/final-linted and request review

  4. Make another PR with manual lint changes into feature/final-linted and request review

  5. Merge feature/final-lintedinto target branch (develop/main)

Purpose

This makes it so that the automatic linting changes can be quickly merged in without needing to go through hundreds of files and thousands of changes. Then once this is complete, any manual changes can be reviewed more closely in a separate PR to ensure there are no breaking changes

Â