CONTRIBUTING.md

Contributing to Trashy Road

This document describes the steps and information to contribute to TrashyRoad.

Assets

Assets are located in the assets directory.

Adding assets

1. Include your new asset file inside the assets directory.

packages/
├─ trashy_road/
│  ├─ assets/
│  │  ├─ trash_can.png
│  ├─ pubspec.yaml

2. Generate a new Assets class, with flutter_gen.

dart run build_runner build

3. Use you new asset in code:

import 'package:trashy_road/gen/gen.dart';

void main() {
  Assets.images.trashCan;
}

Testing

Running tests

1. Run the game tests:

flutter test