Skip to content

Commit 2056fe1

Browse files
committed
Updating CONTRIBUTING.md
1 parent 4b92df1 commit 2056fe1

File tree

7 files changed

+10
-626
lines changed

7 files changed

+10
-626
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,16 @@ yet in the issue tracker, start by opening an issue. Thanks!
2525
2. When a change is user-facing, please add a new entry to the [changelog](https://github.com/dart-lang/dartdoc/blob/master/CHANGELOG.md)
2626
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`.
2727
4. For major changes, run `grind compare-sdk-warnings` and `grind compare-flutter-warnings`, and include the summary results in your pull request.
28-
5. Be sure to format your Dart code using `dartfmt -w`, otherwise travis will complain.
29-
6. Post your change via a pull request for review and integration!
28+
5. Be sure to format your Dart code using `dartfmt -w`, otherwise travis will complain.
29+
6. Because there are generated versions of the dartdoc docs for stable and development versions of Dart,
30+
you need to update the docs twice:
31+
- Download and install the latest STABLE version of dart from [the Dart website](https://www.dartlang.org/tools/sdk).
32+
(It's probably easiest to download a zip file and change your PATH to the extracted location's `bin` directory)
33+
- Run `pub run grinder update-test-package-docs` to update the stable docs.
34+
- Download and install the latest DEV version of dart from [the Dart website](https://www.dartlang.org/tools/sdk)
35+
(It's probably easiest to download a zip file and change your PATH to the extracted location's `bin` directory)
36+
- Run `pub run grinder update-test-package-docs` to update the dev docs.
37+
7. Post your change via a pull request for review and integration!
3038

3139
## Testing
3240

testing/test_package_docs/package-args_args/OptionType/FLAG-constant.html

Lines changed: 0 additions & 104 deletions
This file was deleted.

testing/test_package_docs/package-args_args/OptionType/MULTIPLE-constant.html

Lines changed: 0 additions & 104 deletions
This file was deleted.

testing/test_package_docs/package-args_args/OptionType/SINGLE-constant.html

Lines changed: 0 additions & 104 deletions
This file was deleted.

0 commit comments

Comments
 (0)