Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.23 KB

File metadata and controls

59 lines (45 loc) · 2.23 KB

How to become a contributor

Development Setup

Before you begin making changes to the repository, ensure you have the following tools and have run the setup commands:

Prerequisites

  • Dart SDK (latest stable version)
  • Flutter SDK (if working with Flutter examples)
  • Java (version 8 or higher) - required for OpenAPI Generator CLI

Setup Steps

  1. Activate Melos globally (for monorepo management):

    dart pub global activate melos
  2. Bootstrap the workspace (links local packages and sets up dependencies):

    melos bootstrap
  3. Get dependencies for all packages:

    melos exec dart pub get
  4. Format code before committing:

    melos format

Before submitting an issue

  • Search the open issue and closed issue to ensure no one else has reported something similar before.
  • File an issue ticket by providing all the required information. Failure to provide enough detail may result in slow response from the community.
  • You can also make a suggestion or ask a question by opening an "issue".

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, fork the desired repo, develop and test your code changes.
  4. Ensure that your code adheres to the existing style in the code to which you are contributing.
  5. Ensure that your code has an appropriate set of tests which all pass.
  6. Always run melos format before committing to ensure consistent code formatting across the repository.
  7. Title your pull request as well as all your commits following Conventional Commits styling.
  8. Submit a pull request.

Note

It is important that all your commits as well as your PR follow the Conventional Commits styling.