diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..f43eecfd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,48 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [2.0.0] - 2020-02-20 + +### Added + +- Add import rules to base config (#24) +- Clarified TypeScript config & publishing docs + +### Changed + +- Explicitly specify all core rules (#17) +- Update TypeScript config (#25) + +### Removed + +- Remove root flag from TS config (#20) + +## [1.2.0] - 2020-02-18 + +### Changed + +- Disable Jest lowercase-name for describe blocks (#14) + +## [1.1.0] - 2020-02-11 + +### Added + +- Add README file +- Add Mocha config (#13) + +## [1.0.0] - 2020-01-21 + +### Added + +- Add base, TypeScript, and Jest configs (#3) + +[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v2.0.0...HEAD +[2.0.0]:https://github.com/MetaMask/eslint-config/compare/v1.2.0...v2.0.0 +[1.2.0]:https://github.com/MetaMask/eslint-config/compare/v1.1.0...v1.2.0 +[1.1.0]:https://github.com/MetaMask/eslint-config/compare/v1.0.0...v1.1.0 +[1.0.0]:https://github.com/MetaMask/eslint-config/tree/v1.0.0 diff --git a/README.md b/README.md index 917c4286..6f4a0abc 100644 --- a/README.md +++ b/README.md @@ -96,5 +96,30 @@ module.exports = { '@metamask/eslint-config', '@metamask/eslint-config/config/typescript', ], + // If you have JS files for config, etc. you'll need to set their sourceType + // explicitly as the default sourceType for TS projects is 'module' + overrides: [{ + files: [ + '.eslintrc.js', + ], + parserOptions: { + sourceType: 'script', + }, + }], }; ``` + +## Release & Publishing + +The project follows the same release process as the other libraries in the MetaMask organization: + +1. Create a release branch + - For a typical release, this would be based on `master` + - To update an older maintained major version, base the release branch on the major version branch (e.g. `1.x`) +2. Update the changelog +3. Update version in package.json file (e.g. `yarn version --minor --no-git-tag-version`) +4. Create a pull request targeting the base branch (e.g. master or 1.x) +5. Code review and QA +6. Once approved, the PR is squashed & merged +7. The commit on the base branch is tagged +8. The tag can be published as needed diff --git a/package.json b/package.json index eae2ec43..8465176a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@metamask/eslint-config", - "version": "1.2.0", + "version": "2.0.0", "description": "Shareable MetaMask ESLint config", "main": "config/index.js", "publishConfig": {