Thanks for thinking about helping with dart.dev! You can contribute in a few ways.
-
Fix typos. The GitHub UI makes it easy to contribute small fixes, and you'll get credit for your contribution! To begin, click the page icon at the upper right of the page. Then click the pencil icon to start editing the file. Once you've fixed the typo, commit your changes to a new branch in your forked repository and create a pull request.
Once we've reviewed and approved your change, we'll merge it. Normally, we'll review your fix within one working day, and your fix will appear online less than an hour after we merge your PR.
Note: If this is your first contribution to a Google project—welcome!—you'll need to sign the CLA.
-
Fix known issues. These issues may or may not be easy to fix. Sometimes they're issues that we don't have the expertise to fix, and we'd love to work with a contributor who has the right skills.
More info:
- To avoid wasting your time, talk with us before you make any nontrivial
pull request. The issue tracker is a good way to track your progress
publicly, but we also use the
#hackers-devrelchannel on Flutter's Discord server. - We use the usual GitHub pull request process.
- We follow the Google Developer Documentation Style Guide, with some additional conventions that we try to document in the site-shared repo. In particular, we use semantic line breaks.
- For more ways to contribute to Dart, see the dart-lang/sdk Contributing page.
If your PR changes Dart code within a page, you'll probably need to change the code in two places:
- In a
.mdfile for the page. - In a
.dartfile under the/examplesdirectory.
For example, say you want to change the following code in the Variables documentation:
<?code-excerpt "misc/lib/language_tour/variables.dart (var-decl)"?>
```dart
var name = 'Bob';
```
Besides editing
/src/content/language/variables.md
(which you can find by clicking the GitHub icon at the top right of the page),
you'll also need to edit the var-decl region of
/examples/misc/lib/language_tour/variables.dart.
If you create a PR but forget to edit the Dart file, or if your changes don't analyze/test cleanly, the GitHub Actions CI build will fail. Just update the PR, and GitHub Actions will run again.
If you followed the setup in the README,
you can instead run dart run dart_site refresh-excerpts
from the root directory of the repository to update the Markdown files.
We pledge to maintain an open and welcoming environment. For details, see our code of conduct.