Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.93 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.93 KB
Raw

BestDoctor ESLint config

npm version Build Status Maintainability Test Coverage

This package provides BestDoctor's .eslintrc as an extensible shared config.

Installation

  1. Install the package: yarn add @bestdoctor/eslint-config -D.
  2. Add "extends": "@bestdoctor" to your .eslintrc.

Usage

Run your eslint.

Motivation

We have variety of projects in BestDoctor and we want to have same code style in all of them. Besides eslint we use typescript, jest, react and prettier. That's why we have some cool plugins in this config:

  • @typescript-eslint/eslint-plugin
  • eslint-plugin-import
  • eslint-plugin-jest
  • eslint-plugin-jsx-a11y
  • eslint-plugin-prettier
  • eslint-plugin-react
  • eslint-plugin-react-hooks

We also have a frontend styleguide (only in russian, sorry).

Contributing

We would love you to contribute to our project. It's simple:

  • Create an issue with bug you found or proposal you have. Wait for approve from maintainer.
  • Create a pull request. Make sure all checks are green.
  • Fix review comments if any.
  • Be awesome.

Here are useful tips:

  • You can run all checks and tests with yarn makecheck. Please do it before TravisCI does.
  • We respect Django CoC. Make soft, not bullshit.