Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 994 Bytes

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 994 Bytes
Raw

Contributing

Thank you for contributing to easy_theme_extension.

Project Structure

  • easy_theme_extension → Annotation and public API
  • easy_theme_extension_builder → Code generator implementation

Setup

  1. Clone the repository:
git clone https://github.com/albinpk/easy_theme_extension.git
cd easy_theme_extension
  1. Install dependencies:
dart pub get
  1. Run tests:
dart test
  1. Run build_runner when modifying generator logic:
dart run build_runner build

Guidelines

  • Keep the API minimal and declarative.
  • Avoid adding unnecessary configuration.
  • Ensure generated code remains clean and readable.
  • Add or update tests for any behavior changes.
  • Do not introduce breaking changes without discussion.

Pull Requests

  • Keep PRs focused and atomic.
  • Include a clear explanation of the change.
  • Ensure all tests pass before submitting.

For major changes, open an issue first to discuss the design.