/
CONTRIBUTING.md
147 lines (94 loc) · 8.13 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
Want to contribute? Great! First, read this page (including the small print at the end).
## Ways you can contribute
You can help the Dart project in many ways, in addition to contributing code. For example, you can [report bugs](https://dartbug.com), ask and answer [Dart questions on StackOverflow](https://stackoverflow.com/questions/tagged/dart), and improve the documentation.
If you'd like to improve the documentation, you have three options:
* Give us feedback:
* If you're looking at a page with a **bug icon** at the **upper right**,
click that icon to report a bug on the page.
* To report an API doc bug,
[create an SDK issue](https://github.com/dart-lang/sdk/issues/new?title=API%20doc%20issue:).
* Contribute to the Dart developer websites such as [dart.dev](https://dart.dev) (repo: [dart-lang/site-www](https://github.com/dart-lang/site-www)). For more information, see [Writing for Dart and Flutter websites](https://github.com/dart-lang/site-shared/blob/master/doc/writing-for-dart-and-flutter-websites.md).
* Improve the API reference docs at [api.dart.dev](https://api.dart.dev) by editing doc comments in the [Dart SDK repo](https://github.com/dart-lang/sdk/tree/main/sdk/lib). For more information on how to write API docs, see [Effective Dart: Documentation](https://dart.dev/guides/language/effective-dart/documentation).
## Before you contribute
Before we can use your code, you must sign the [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual) (CLA), which you can do online. The CLA is necessary mainly because you own the copyright to your changes, even after your contribution becomes part of our codebase, so we need your permission to use and distribute your code. We also need to be sure of various other things—for instance that you'll tell us if you know that your code infringes on other people's patents. You don't have to sign the CLA until after you've submitted your code for review and a member has approved it, but you must do it before we can put your code into our codebase.
Before you start working on a larger contribution, you should get in touch with us first through the [Dart Issue Tracker](https://dartbug.com) with your idea so that we can help out and possibly guide you. Coordinating up front makes it much easier to avoid frustration later on.
All submissions, including submissions by project members, require review. We use the same code-review tools and process as the chromium project.
We occasionally take pull requests, e.g., for comment changes, but the main flow is to use the Gerrit review system as explained below.
## Submitting patches directly from GitHub
This repository primarily uses [Gerrit for code reviews](https://dart-review.googlesource.com/), rather than GitHub PRs. However, you may submit [a GitHub PR ](https://github.com/dart-lang/sdk/pulls), e.g. to edit some API documentation, and it will be automatically converted into a Gerrit change list (a "CL") by a copybara-service bot. You can find the link to that CL as a comment left on the PR by the bot. Any changes made to the PR after opening will also be sync'ed by the bot into the Gerrit review. The PR will be automatically closed when the CL is reviewed and landed.
## Setting up the environment
In order to submit a patch from a local workspace, you need to install the Chromium
[depot\_tools](https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up).
## Getting the code
To work with the Dart code, you need to download and build the development branch. Active development of Dart takes place on the `main` branch, from which we push "green" versions that have passed all tests to `dev` branch. Complete instructions are found at [Getting The Source](https://github.com/dart-lang/sdk/wiki/Building#getting-the-source). **You must use the `gclient` tool (`fetch`), using `git clone` will not get you a functional environment!**
## Starting a patch with git
Create a new branch using `git new-branch` (this is a command added by the aforementioned depot_tools).
You can be in any branch when you run `git new-branch`.
```bash
git new-branch <feature name>
<write code>
git commit
<write code...>
git commit
...
```
## Keeping your branch updated with origin/main
As you work, and before you send a patch for review, you should
ensure your branch is merging cleanly to `origin/main`.
There are multiple ways to do this, but we generally recommend
using `git rebase-update` (another feature added by depot_tools):
```bash
git rebase-update
```
You can run this command from any branch.
This command will fetch
`origin/main`, rebase all your open branches, and delete
cleanly merged branches.
Your local workflow may vary.
## Uploading the patch for review
Upload the patch to Gerrit for review using `git cl upload`:
```bash
# Upload a CL, add reviewers from OWNERS files, and allow automatic submission.
git cl upload --send-mail --r-owners --auto-submit
```
The above command returns a URL for the review. Attach this review to your issue in https://dartbug.com.
To update the CL, just commit your changes and run `git cl upload` for your branch again.
More detailed instructions for the `git cl` tools available on https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_creating_uploading_a_cl
## Getting your patch reviewed and landed submitted.
Ensure that your change has at least two reviewers who are OWNERS on your CL:
```bash
git cl web # opens your review on https://dart-review.googlesource.com
```
Check the "Reviewers" on the CL, there should be at least two. If there aren't,
use the "ADD OWNERS" button to add more. If you can't get enough reviewers, or
the reviewers are not responsive, you may add reviewers found in the `OWNERS`
file at the root of the repository to escalate.
It's part of a code owner's responsibility to review changes in their area and
help you to get your patch submitted. They may also provide comments, or reject
your CL. They can run the presubmit tests on your behalf and submit your patch.
## For committers: Submitting a patch
If you have commit access, when the review is done and the patch is good to go, submit the patch on https://dart-review.googlesource.com:
* Press "Submit to CQ" (CQ stands for "Commit Queue").
* You can follow the progress by looking at the "Tryjobs" panel in your review.
* Once the Commit Queue is green, the patch will be merged.
* If any of the try jobs is red, you will have to fix the errors and then "Submit to CQ" once more.
If you do not have commit access, a Dart engineer will commit on your behalf, assuming the patch is reviewed and accepted.
## For committers: Merging contributions from non-members
If the author of a patch is not a committer, they will need help landing the patch.
Once a patch gets an LGTM, it's easy for a committer to merge it in.
* Find and open the review on https://dart-review.googlesource.com.
* Follow the instructions in the previous section to submit the patch.
## Coding style
The source code of Dart follows the:
* [Google C++ style guide](https://google.github.io/styleguide/cppguide.html)
* [Dart style guide](https://dart.dev/guides/language/effective-dart/style)
You should familiarize yourself with those guidelines.
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 (not a range; don't use "2011-2012", even if the original code did). If you edit an existing file you don't have to update the year.
```dart
// Copyright (c) 2017, 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.
```
## The small print
Contributions made by corporations are covered by a different agreement than the one above, the [Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).
We pledge to maintain an open and welcoming environment. For details, see our [code of conduct](https://dart.dev/code-of-conduct).