Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (40 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 1.93 KB

Contributing to Levit

First off, thank you for considering contributing to Levit! It's people like you that make Levit such a great tool for the community.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please act professionally and respectfully at all times.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as well as as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with the enhancement label.
  • Explain why this enhancement would be useful to most Levit users.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

Development Setup

Levit is a monorepo managed by Melos.

Prerequisites

  • Dark SDK
  • Flutter SDK
  • Melos (dart pub global activate melos)

Bootstrap

To link all local packages and install dependencies:

melos bootstrap

Running Tests

To run tests across all packages:

melos run test
melos run test:flutter

Style Guide

  • We follow the official Dart Style Guide.
  • We value explicit over implicit. Code should be easy to read and understand.
  • We prioritize correctness over convenience.

License

By contributing, you agree that your contributions will be licensed under its MIT License.