diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index aeca03e4..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,62 +0,0 @@ -# How to Contribute - -We'd love to accept your patches and contributions to this project. There are -just a few small guidelines you need to follow. - -## Contributor License Agreement - -Contributions to this project must be accompanied by a Contributor License -Agreement (CLA). You (or your employer) retain the copyright to your -contribution; this simply gives us permission to use and redistribute your -contributions as part of the project. Head over to - to see your current agreements on file or -to sign a new one. - -You generally only need to submit a CLA once, so if you've already submitted one -(even if it was for a different project), you probably don't need to do it -again. - -## Code Reviews - -All submissions, including submissions by project members, require review. We -use GitHub pull requests for this purpose. Consult -[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. - -## Coding style - -The Dart source code in this repo follows the: - - * [Dart style guide](https://dart.dev/guides/language/effective-dart/style) - -You should familiarize yourself with those guidelines. - -## File headers - -All files in the Dart project must start with the following header; if you add a -new file please also add this. The year should be a single number stating the -year the file was created (don't use a range like "2011-2012"). Additionally, if -you edit an existing file, you shouldn't update the year. - - // Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file - // for details. All rights reserved. Use of this source code is governed by a - // BSD-style license that can be found in the LICENSE file. - -## Community Guidelines - -This project follows -[Google's Open Source Community Guidelines](https://opensource.google/conduct/). - -We pledge to maintain an open and welcoming environment. For details, see our -[code of conduct](https://dart.dev/code-of-conduct). - -## Regenerate Dependency Diagrams - -The [LayerLens](https://github.com/polina-c/layerlens) diagrams -will be auto-regenerated by GitHub after each push to main branch. -To regenerate diagrams locally run `dart run layerlens` in the -project root. - -# Coding conventions - -Libraries that start with '_' are private and thus are not exported. diff --git a/README.md b/README.md index 88e279ea..94904c06 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ - -Coming soon! See https://github.com/flutter/devtools/issues/3951 and https://github.com/flutter/devtools/issues/5606. - -The text below is under construction. - [![CI](https://github.com/dart-lang/leak_tracker/actions/workflows/ci.yaml/badge.svg)](https://github.com/dart-lang/leak_tracker/actions/workflows/ci.yaml) +[![pub package](https://img.shields.io/pub/v/leak_tracker.svg)](https://pub.dev/packages/leak_tracker) +[![package publisher](https://img.shields.io/pub/publisher/leak_tracker.svg)](https://pub.dev/packages/leak_tracker/publisher) -# Memory Leak Tracker +Coming soon! See https://github.com/flutter/devtools/issues/3951 and +https://github.com/flutter/devtools/issues/5606. -TODO: replace links with absolute, to make them working on pub.dev +## Memory Leak Tracker -This is a framework for detecting memory issues in Dart and Flutter applications. It enables: +TODO: The text below is under construction. + +This is a framework for detecting memory issues in Dart and Flutter +applications. It enables: 1. [Memory leak auto-detection](doc/DETECT.md) for applications and tests. 2. [Memory usage tracking and auto-snapshotting](doc/USAGE.md). @@ -17,5 +18,3 @@ This is a framework for detecting memory issues in Dart and Flutter applications Documentation: 1. [Understand leak tracking concepts](doc/CONCEPTS.md) 2. [Troubleshoot memory leaks](doc/TROUBLESHOOT.md) - -[leak_tracker on pub.dev](https://pub.dev/packages/leak_tracker) diff --git a/pubspec.yaml b/pubspec.yaml index 45fe18e5..8b214600 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -23,6 +23,6 @@ dev_dependencies: flutter_lints: ^2.0.0 flutter_test: sdk: flutter - layerlens: + layerlens: ^1.0.11 integration_test: sdk: flutter