Before you begin making changes to the repository, ensure you have the following tools and have run the setup commands:
- Dart SDK (latest stable version)
- Flutter SDK (if working with Flutter examples)
- Java (version 8 or higher) - required for OpenAPI Generator CLI
-
Activate Melos globally (for monorepo management):
dart pub global activate melos
-
Bootstrap the workspace (links local packages and sets up dependencies):
melos bootstrap
-
Get dependencies for all packages:
melos exec dart pub get -
Format code before committing:
melos format
- 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".
- Submit an issue describing your proposed change to the repo in question.
- The repo owner will respond to your issue promptly.
- If your proposed change is accepted, fork the desired repo, develop and test your code changes.
- Ensure that your code adheres to the existing style in the code to which you are contributing.
- Ensure that your code has an appropriate set of tests which all pass.
- Always run
melos formatbefore committing to ensure consistent code formatting across the repository. - Title your pull request as well as all your commits following Conventional Commits styling.
- Submit a pull request.
It is important that all your commits as well as your PR follow the Conventional Commits styling.