Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 1.7 KB

Getting Started

In order to use the mobile app, you would need the flood backend running on your local machine. There are several ways you can do that and all these approaches can be found at Taskwarrior-Flutter

Steps

Installation

  1. Clone the repository from GitHub:
git clone https://github.com/CCExtractor/taskwarrior-flutter.git
  1. Navigate to project's root directory:
cd taskwarrior-flutter
  1. Check for Flutter setup and connected devices:
flutter doctor
  1. Get the dependancies
flutter pub get
  1. Run the app:
flutter run

Check out the app

  1. Open mobile app
    1. Check out the app
    2. Make Profile
    3. Connect with TaskServer
    4. Sync Tasks with it

Prerequisites

  • Flutter
  • VSCode / Android Studio

Contributing

  1. Fork the Project
  2. Clone the Forked Repo. git clone https://github.com/[username]/taskwarrior-flutter.git
  3. Create a branch
    • For your Feature Branch (git checkout -b feature/AmazingFeature)
    • For your Fix Branch (git checkout -b fix/BugFix)
  4. Do the changes in that branch
  5. Add all files (git add .)
    • Do Not add files generated by code editor of Android Studio IDE
    • Only add files that related to your feature
  6. Commit your Changes (git commit -m 'Add some AmazingFeature')
  7. Make sure branch is synced with main branch of CCExtractor/taskwarrior-flutter
    • If not, please sync it and test again
    • If any conflict, resolve according to feature and test again
  8. Push to the Branch (git push origin feature/AmazingFeature)
  9. Open a Pull Request for the main branch.