@devaltitude/eslint-config-base/README.md

The official altitude-sports eslint base configuration

# @devaltitude/eslint-config-base 

This package provides a base Javascript & TypeScript eslint configuration as an extensible shared configuration.


## Installation

On the root folder of your JS app, run the following command:

```bash
yarn add --also=dev @devaltitude/eslint-config-base
```

## Usage

Once the package has been successfully installed, you can add `@devaltitude/eslint-config-base` to your `.eslintrc`.

```js
{
  "extends": "@devaltitude/eslint-config-base"
}

```

## How to contribute👷
Thank you for investing your time in contributing to our project! 💎

Please read the code of Conduct to keep our Alti standards approachable and respectable. [Alti-Docs section: Coding Standards -> Code of Conduct](https://alti-docs.devaltitude.com/coding_standards/code_conduct/branching/)

### Make Changes
1. Clone the repo and make the changes you consider suitable.
    > 📝 Make sure it will benefit globally the JS standards. In case you intend to add a change for a specific domain (cloud, backend or frontend) please extend this configuration and discuss the changes at team level.
2. Add the proposed changes
3. Update semantically the version in package.json. [Check semantic versioning guide](https://docs.npmjs.com/about-semantic-versioning)

### Pull Request 🔍

When you're finished with the changes, create a pull request and add at least one staff engineer as reviewer.
  - Don't forget to link PR to the issue if you are solving one.
  - We may ask for changes to be made before a PR can be merged.
  - As you update your PR and apply changes, mark each conversation as resolved.


### Your PR is merged!
Congratulations 🎉🎉 The Dev Altitude team thanks you ✨.

> 📝 Once the feature branch has been merged a CI pipeline will be triggered. After a few seconds your package should be ready to use.

## Communication 💬
Once you have validated the new version is live here: [@devaltitude/eslint-config-base](https://www.npmjs.com/package/@devaltitude/eslint-config-base). Please send a notification through the Google Tech Team space.