Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.8 KB

Contribute to dartdoc

To use the dartdoc tool, see the user docs. This page contains information relevant for contributors to the dartdoc project.

Can I help?

Yes!

Start by using the tool and filing issues and requests.

See the dartdoc API docs, generated by dartdoc.

If you want to contribute, check out the issue tracker and see if there's an issue that you're passionate about. If you want to add a new feature that's not yet in the issue tracker, start by opening an issue. Thanks!

Build Status Build status

Making Changes

  1. grind is needed to run dartdoc integration tests, see installed via pub global activate grinder.
  2. When a change is user-facing, please add a new entry to the changelog
  3. Please include a test for your change. dartdoc has both package:test-style unittests as well as integration tests. To run the unittests, use dart test/all.dart. Most changes can be tested via a unittest, but some require modifying the (test_package)[https://github.com/dart-lang/dartdoc/tree/master/testing/test_package] and regenerating its docs via grind update-test-package-docs.
  4. Be sure to format your Dart code using dartfmt -w, otherwise travis will complain.
  5. Post your change via a pull request for review and integration!

License

Please see the dartdoc license.