Skip to content

Latest commit

 

History

History
142 lines (96 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

142 lines (96 loc) · 1.7 KB
Raw

Create a new example or package

To create a new example:

  1. Go to examples folder
cd examples
  1. Run the following command:
flutter create example_name --org flyer.chat
  1. Go to the root folder
cd ..
  1. Run melos bootstrap:
melos bs
  1. Replace analysis_options.yaml content with the following:
include: ../../analysis_options.yaml

To create a new package:

  1. Go to packages folder
cd packages
  1. Run the following command:
flutter create package_name --template=package
  1. Go to the root folder
cd ..
  1. Run melos bootstrap:
melos bs
  1. Replace analysis_options.yaml content with the following:
include: ../../analysis_options.yaml
  1. Make sure to follow other packages structure. Minimum required files are:
.dart_tool/
lib/
  src/
    code.dart
  package_name.dart
analysis_options.yaml
CHANGELOG.md
LICENSE
melos_package_name.iml
pubspec.lock
pubspec.yaml
README.md

Remove all other files if needed and update pubspec.yaml similar to other packages.

Remember to run melos bs again after you finished all configs and changed pubspec.yaml file.

Tests

To run tests for a specific package:

melos test:selective

To run all tests:

melos test

To generate coverage for a specific package:

melos coverage:selective

To generate coverage for all packages:

melos coverage

Misc

Get dependencies for all packages:

melos bs

Clean all packages:

melos clean

Build types (flutter_chat_types):

melos build

Additional:

melos analyze
melos format
melos fix