Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.15 KB
Raw

Getting Started

If you're interested in contributing code to AlistHelper, you'll need to follow these steps:

Run

Fork the repository and install Flutter.

After you have installed Flutter, then you can start this app by typing the following commands:

flutter pub get
dart run build_runner build
flutter run

Translation

You can help translating this app to other languages!

  1. Fork this repository
  2. Choose one
    • Add missing translations in existing languages: Only update _missing_translations_<locale>.json in lib/i18n
    • Fix existing translations: Update strings_<locale>.i18n.json in lib/i18n
    • Add new languages: Create a new file, see also: locale codes.
  3. Optional: Re-run this app
    1. Make sure you have run this app once.
    2. Update translations via dart run build_runner build
    3. Run app via flutter run
  4. Open a pull request

Take note: Fields decorated with @ are not meant to be translated, they are not used in the app in any way, being merely informative text about the file or to give context to the translator.

Contributing Guidelines

Before you submit a pull request to AlistHelper, please ensure that you have followed these guidelines:

  • Code should be well-documented and formatted according to the Dart Style Guide.
  • All changes should be covered by tests.
  • Commits should be well-written and descriptive, with a clear summary of the changes made and any relevant context.
  • Pull requests should target the master branch and include a clear summary of the changes made.

Bug Reports and Feature Requests

If you encounter a bug in AlistHelper or have a feature request, please submit an issue to the issue tracker. Please be sure to provide a clear description of the problem or feature request, along with any relevant context or steps to reproduce the issue.