Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 2.45 KB
Raw

Contributing to LocalSend

LocalSend is an open-source project, and we welcome contributions from anyone who is interested in helping improve the app. Whether you're a developer, a translator, or a documentation writer, there are many ways to get involved.

Getting Started

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

Run

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

flutter pub get
flutter pub run build_runner build -d
flutter run

Contributing

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 assets/i18n
    • Fix existing translations: Update strings_<locale>.i18n.json in assets/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 flutter pub run slang
    3. Run app via flutter run
  4. Open a pull request

Contributing Guidelines

Before you submit a pull request to LocalSend, 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 main branch and include a clear summary of the changes made.

Bug Reports and Feature Requests

If you encounter a bug in LocalSend 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.

Security Issues

If you discover a security issue in LocalSend, please do not submit an issue to the public issue tracker. Instead, please email us directly at [email protected] so that we can address the issue as quickly and effectively as possible.