CONTRIBUTING.md

Welcome to cmd contributing guide 👋🏻

Flutter command line toolkit

Thank you for investing your time in contributing to cmd project! Any contribution you make will be reflected on pub.dev/packages/cmd.

Read our Code of Conduct to keep our community approachable and respectable.

Directory Structure Guide

The scripts are categorized by framework wise. So, developers from other stack may find useful scripts easily.

├── cmd
│   ├── [framework]
│   │   ├── cmd
│   │   │   └── [script.sh]

For example, we have a sample script for flutter doctor command that's used to inspect Flutter Framework Environment.

├── cmd
│   ├── flutter
│   │   ├── cmd
│   │   │   └── doctor.sh

Script File Guide

• Make sure you add descriptions in comments followed by # or ## above each script or in the start of Batch Scripts.
• Add #!/bin/sh the in the beginning of script.

#!/bin/sh

##? Inspecting the current state of the Flutter environment
flutter doctor -v

##? Checking for the latest version of Flutter
# flutter upgrade

##? Checking for the latest version of Flutter with force update
# flutter upgrade --force

Integrating Scripts in Code

Please navigate to file scripts.dart

├── cmd
│   ├── flutter
│   │   ├── bin
│   │   │   └── scripts.dart

Please add script files into the list as mentioned below:

/// Integrating Scripts into the code
  List<String> scripts = [
    'doctor.sh',
    'run.sh',
    'build.sh',
    // Add your scripts here...
  ];