CONTRIBUTING.md

Contributing ❤️

Thanks for thinking about helping with www.dartlang.org! Here are a couple of ways that you can contribute:

• Report issues.
• Fix issues (especially ones with the label help wanted).
  • If this is your first contribution—welcome!—please sign the CLA and check out issues that are labeled beginner. Beginner issues may or may not be easy to fix. Sometimes they're issues we don't have the expertise to fix ourselves, and we'd love to work with a contributor who has the right skills.
  • We use the usual GitHub pull request process.
  • We follow the Google Developer Documentation Style Guide.

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 can also communicate other ways such as email and Gitter.

For more information on contributing to Dart, see the dart-lang/sdk Contributing page.

Updating code samples

If your PR changes Dart code within a page, you'll probably need to change the code in two places:

1. In a .md file for the page.
2. In a .dart file under the /examples directory.

For example, say you want to change the following code in the language tour:

<?code-excerpt "misc/lib/language_tour/variables.dart (var-decl)"?>
{% prettify dart %}
var name = 'Bob';
{% endprettify %}

Besides editing /src/_guides/language/language-tour.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 Travis CI build will fail. Just update the PR, and Travis will try again.