From 51bf6feeea842152e0f7829195f1f7ca57dc6442 Mon Sep 17 00:00:00 2001 From: jamsch <12927717+jamsch@users.noreply.github.com> Date: Tue, 15 Oct 2024 16:25:34 +1300 Subject: [PATCH] chore: remove linter and update contributing guide --- .github/workflows/ci.yml | 15 --------------- CONTRIBUTING.md | 32 +------------------------------- package.json | 1 - 3 files changed, 1 insertion(+), 47 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 37d6388..b553189 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,21 +8,6 @@ on: - master jobs: - lint: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - - - name: Setup - uses: ./.github/actions/setup - - - name: Lint files - run: yarn lint - - - name: Typecheck files - run: yarn typecheck - build: runs-on: ubuntu-latest steps: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c29109..cddb3de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,25 +38,6 @@ To run the example app on Web: yarn example web ``` -Make sure your code passes TypeScript and ESLint. Run the following to verify: - -```sh -yarn typescript -yarn lint -``` - -To fix formatting errors, run the following: - -```sh -yarn lint --fix -``` - -Remember to add tests for your change if possible. Run the unit tests by: - -```sh -yarn test -``` - ### Commit message convention We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages: @@ -70,14 +51,6 @@ We follow the [conventional commits specification](https://www.conventionalcommi Our pre-commit hooks verify that your commit message matches this format when committing. -### Linting and tests - -[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/) - -We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing. - -Our pre-commit hooks verify that the linter and tests pass when committing. - ### Publishing to npm We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc. @@ -93,9 +66,7 @@ yarn release The `package.json` file contains various scripts for common tasks: - `yarn bootstrap`: setup project by installing all dependencies and pods. -- `yarn typescript`: type-check files with TypeScript. -- `yarn lint`: lint files with ESLint. -- `yarn test`: run unit tests with Jest. +- `yarn typecheck`: type-check files with TypeScript. - `yarn example start`: start the Metro server for the example app. - `yarn example android`: run the example app on Android. - `yarn example ios`: run the example app on iOS. @@ -107,7 +78,6 @@ The `package.json` file contains various scripts for common tasks: When you're sending a pull request: - Prefer small pull requests focused on one change. -- Verify that linters and tests are passing. - Review the documentation to make sure it looks good. - Follow the pull request template when opening a pull request. - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue. diff --git a/package.json b/package.json index 5cfcea3..3f6d225 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,6 @@ ], "scripts": { "typecheck": "tsc --noEmit", - "lint": "eslint \"src/**/*.{js,ts,tsx}\"", "prepack": "bob build", "release": "release-it", "example": "yarn --cwd example",