Skip to content

Commit 79cbfe1

Browse files
authored
Correct typos (#8324)
- [x] I’ve reviewed the contributor guide and applied the relevant portions to this PR.
1 parent 81d0746 commit 79cbfe1

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Contributing to Flutter Plugin for IntelliJ
2727
![GitHub contributors](https://img.shields.io/github/contributors/flutter/flutter-intellij.svg)
2828

2929
We gladly accept contributions via GitHub pull requests!
30-
If you are new to codiing IntelliJ plugins,
31-
here are a couple links to get started:
30+
If you are new to coding IntelliJ plugins,
31+
here are a couple of links to get started:
3232

3333
- [INTRODUCTION TO CREATING INTELLIJ IDEA PLUGINS](https://developerlife.com/2020/11/21/idea-plugin-example-intro/)
3434
- [ADVANCED GUIDE TO CREATING INTELLIJ IDEA PLUGINS](https://developerlife.com/2021/03/13/ij-idea-plugin-advanced/)
@@ -43,13 +43,13 @@ name and contact info to the [AUTHORS](AUTHORS) file.
4343
1. Install Flutter SDK from [Flutter SDK download](https://flutter.dev/docs/get-started/install) or
4444
[GitHub](https://github.com/flutter/flutter) and set it up according to its instructions.
4545
2. Verify installation from the command line:
46-
- Connect an android device with USB debugging.
46+
- Connect an Android device with USB debugging.
4747
- `cd path/to/flutter/examples/hello_world`
4848
- `flutter pub get`
4949
- `flutter doctor`
5050
- `flutter run`
5151
3. Fork `https://github.com/flutter/flutter-intellij` into your own GitHub account.
52-
If you already have a fork, and are now installing a development environment on a new machine,
52+
If you already have a fork and are now installing a development environment on a new machine,
5353
make sure you've updated your fork with the master branch
5454
so that you don't use stale configuration options from long ago.
5555
4. `git clone -c core.symlinks=true https://github.com/<your_name_here>/flutter-intellij`
@@ -59,13 +59,13 @@ name and contact info to the [AUTHORS](AUTHORS) file.
5959

6060
## Environment set-up
6161

62-
1. Install the lastest [Java Development Kit](https://www.java.com/en/download/).
62+
1. Install the latest [Java Development Kit](https://www.java.com/en/download/).
6363
- The current Java Development Kit version is: **23**.
6464
- **[Googlers only]** Install Java from go/softwarecenter instead.
6565

6666
2. Set your `JAVA_HOME` directory in the configuration file for your shell environment.
6767
- For example, on macOS, the following works:
68-
Check what version of java you have:
68+
Check what version of Java you have:
6969
```shell
7070
/usr/libexec/java_home -V
7171
```
@@ -86,7 +86,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
8686
```shell
8787
which flutter
8888
```
89-
This should print out a path to the Flutter SDK such as:
89+
This should print out a path to the Flutter SDK, such as:
9090
```shell
9191
home/path/to/flutter/bin/flutter
9292
```
@@ -95,8 +95,8 @@ name and contact info to the [AUTHORS](AUTHORS) file.
9595
export FLUTTER_SDK="$HOME/path/to/flutter"
9696
```
9797

98-
4. Set your `DARK_SDK` path in the configuration file for your shell environment.
99-
- In your shell configuration file (e.g. `.bashrc` or `.zshrc`), set your `DART_SDK` env variable to match the Dart SDK in your Flutter SDK. This should look like the `FLUTTER_SDK` path (added above) with `/bin/cache/dart-sdk` appened to the end.
98+
4. Set your `DART_SDK` path in the configuration file for your shell environment.
99+
- In your shell configuration file (e.g. `.bashrc` or `.zshrc`), set your `DART_SDK` env variable to match the Dart SDK in your Flutter SDK. This should look like the `FLUTTER_SDK` path (added above) with `/bin/cache/dart-sdk` appended to the end.
100100
```shell
101101
export DART_SDK="$HOME/path/to/flutter/bin/cache/dart-sdk"
102102
```
@@ -108,7 +108,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
108108
```
109109

110110
6. Update your current `PATH`.
111-
- Either re-start your terminal or run `source ~/.zshrc` / `source ~/.bashrc` to add the new environment variables to your `PATH`.
111+
- Either restart your terminal or run `source ~/.zshrc` / `source ~/.bashrc` to add the new environment variables to your `PATH`.
112112

113113
## IntelliJ set-up
114114

@@ -138,7 +138,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
138138
```
139139
- **[Note]** If you want, you can manually change these properties to target different versions of IntelliJ. See `product-matrix.json` to find which configurations are supported.
140140
141-
3. Start the IntelliJ IDEA with the `flutter-intellij` project.
141+
3. Start IntelliJ IDEA with the `flutter-intellij` project.
142142
- If you see a popup with "Gradle build scripts found",
143143
**confirm loading the Gradle project, and wait until syncing is done.**
144144
- If you didn't see the popup at the first start, **delete & re-clone the repo** and try again.
@@ -158,7 +158,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
158158

159159
2. Add the IntelliJ JBR from disk:
160160
- Select "Platform Settings > SDKs"
161-
- Click the "+" sign at the top "Add New SDK (Alt+Insert)", then select "Add JDK from disk...".
161+
- Click the "+" sign at the top, click "Add New SDK (Alt+Insert)", then select "Add JDK from disk...".
162162
- Select your IntelliJ application (most likely under `Applications`) and from there, select the `Contents/jbr/Contents/Home` directory
163163
- **[For macos]** You won't be able to select the `Contents` directory from Finder without right-clicking on the IntelliJ application, and selecting "Quick Look" from the dropdown that opens. From there, you can select the `Contents` directory.
164164
- Change the name so that you can easily identify it, e.g. `IDEA JBR 21`.
@@ -170,11 +170,11 @@ name and contact info to the [AUTHORS](AUTHORS) file.
170170
171171
3. Add the IntelliJ Platform Plugin SDK
172172
- Select "Platform Settings > SDKs"
173-
- Click the "+" sign at the top "Add New SDK (Alt+Insert)", then select "Add IntelliJ Platform Plugin SDK...".
173+
- Click the "+" sign at the top, click "Add New SDK (Alt+Insert)", then select "Add IntelliJ Platform Plugin SDK...".
174174
- **[Note]** If you don't see this option, ensure you have the DevKit plugin installed.
175175
- Select your IntelliJ application (most likely under `Applications`) and from there, select the `Contents` directory
176176
- **[For macos]** You won't be able to select the `Contents` directory from Finder without right-clicking on the IntelliJ application, and selecting "Quick Look" from the dropdown that opens.
177-
- Remember the generated name (probably `IntelliJ IDEA IU-231.8109.175`) or change to name to format like this.
177+
- Remember the generated name (probably `IntelliJ IDEA IU-231.8109.175`) or change to name to a format like this.
178178
- Change the **Internal Java Platform** to the JBR you added in step 2. (e.g. `IDEA JBR 21`).
179179
- When you are done, your settings should look something like:
180180
```
@@ -195,7 +195,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
195195
- Select "Project Settings > Modules"
196196
- Select the `flutter-intellij > flutter-idea` module
197197
- Switch to the "Paths" window
198-
- Select the **Inherit project compile output path** option then apply.
198+
- Select the **Inherit project compile output path** option, then apply.
199199
200200
6. Change the modules SDK to the Project SDK
201201
- Select "Project Settings > Modules"
@@ -205,7 +205,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
205205
206206
### Configure the Gradle settings
207207
208-
1. From IntelliJ, Open the "Settings" dialog (`IntelliJ IDEA | Settings`).
208+
1. From IntelliJ, open the "Settings" dialog (`IntelliJ IDEA | Settings`).
209209
210210
2. Change the Gradle JVM to the Project SDK
211211
- Select "Build, Execution, Deployment > Build Tools > Gradle"
@@ -234,22 +234,22 @@ name and contact info to the [AUTHORS](AUTHORS) file.
234234
235235
### Build and run the plugin
236236
237-
1. One-time Dart plugin install - first-time a new IDE is installed and run you will need to install the Dart plugin.
237+
1. One-time Dart plugin install - first time a new IDE is installed and run, you will need to install the Dart plugin.
238238
- Find `Plugins` (in "File | Settings | Plugins") and install the Dart plugin, then restart the IDE if needed.
239239
240240
2. [Optional] Add a key for JX Browser (see **Working with Embedded DevTools (JxBrowser)** below)
241241
- **[Note]** This is only required if you are making changes to the embedded views.
242242
243243
3. Build the project using `Build` | `Build Project`.
244244
245-
4. Try running the plugin; select the `flutter-intellij [runIde]` run config then click the Debug icon.
245+
4. Try running the plugin; select the `flutter-intellij [runIde]` run config, then click the Debug icon.
246246
This should open the "runtime workbench", a new instance of IntelliJ IDEA with the plugin installed.
247247
248-
5. If the Flutter Plugin doesn't load (Dart code or files are unknown) see above "One-time Dart plugin install".
248+
5. If the Flutter Plugin doesn't load (Dart code or files are unknown), see above "One-time Dart plugin install".
249249
250250
6. Verify installation of the Flutter plugin:
251251
- Select `flutter-intellij [runIde]` in the Run Configuration drop-down list.
252-
- Click Debug button (to the right of that drop-down).
252+
- Click the Debug button (to the right of that drop-down).
253253
- In the new IntelliJ process that spawns, open the `path/to/flutter/examples/hello_world` project.
254254
- Choose `Edit Configurations...` in the Run Configuration drop-down list.
255255
- Expand `Edit configuration templates...` and verify that Flutter is present.
@@ -281,19 +281,19 @@ since they can lead to various file-based issues during development.
281281
282282
## Provision Tool
283283
284-
This is not currently required. However, for debugging unit tests it may be handy; please ignore for now.
284+
This is not currently required. However, for debugging unit tests, it may be handy; please ignore for now.
285285
286286
The Gradle build script currently assumes that some dependencies are present in the `artifacts` directory.
287287
This project uses an External Tool in IntelliJ to ensure the dependencies are present.
288288
It appears that external tools are not shareable.
289289
To make one, open the "Run Configuration" dialog and select "Flutter Plugin".
290290
Look at the "Before launch" panel. It probably displays an Unknown External Tool.
291-
Double-click that, then click edit icon in the new panel (pencil).
291+
Double-click that, then click the edit icon in the new panel (pencil).
292292
Set the name to "Provision". Set the values:
293293
294-
- Program: /bin/bash
295-
- Arguments: bin/plugin test -s
296-
- Working directory: $ProjectFileDir$
294+
- Program: `/bin/bash`
295+
- Arguments: `bin/plugin test -s`
296+
- Working directory: `$ProjectFileDir$`
297297
- You can select that from a list by clicking the "+" symbol in the field
298298
299299
There is a screenshot of this dialog in `resources/intellij/Provision.png`.
@@ -312,18 +312,18 @@ The definition is in `resources/intellij/External Tools.xml`.
312312
[Note: this may be out-of-date. It has not been verified recently.]
313313
314314
The repository contains two pre-defined test run configurations.
315-
One is for "unit" tests; that is currently defined as tests
315+
One is for "unit" tests; that is, currently defined as tests
316316
that do not rely on the IntelliJ UI APIs.
317317
The other is for "integration" tests - tests that do use the IntelliJ UI APIs.
318318
The integration tests are larger, long-running tests that exercise app use cases.
319319
320-
In order to be able to debug a single test class or test method you need to do the following:
320+
To be able to debug a single test class or test method, you need to do the following:
321321
322322
* Open the test source file in the editor. Navigate to `flutter-idea/testSrc/unit/...` to open it.
323323
* Tests must run using Gradle, so be sure to open the source from the Gradle module.
324324
* Find the test you want to run. Right-click the green triangle next to the test name and choose `Debug <test-name>`.
325325
326-
The test configuration can be tricky due to IntelliJ platform versioning.
326+
The test configuration can be tricky due to the IntelliJ platform versioning.
327327
The plugin tool (below) can be a more reliable way to run tests.
328328
329329
### Using the plugin tool on the command line
@@ -342,24 +342,24 @@ It is also possible to run tests directly with Gradle, which would allow passing
342342
./gradlew test
343343
```
344344
345-
If you wanted to run a subset of the tests you could do so this way.
345+
If you wanted to run a subset of the tests, you could do so this way.
346346
See the [Gradle docs](https://docs.gradle.org/current/userguide/java_testing.html)
347347
for more info about testing.
348348
*However*, you must have run the tests once using the plugin tool,
349349
to ensure all the dependencies have been configured.
350350
351351
## Adding platform sources
352352
353-
Sometimes browsing the source code of IntelliJ is helpful for understanding platform details that aren't documented.
353+
Sometimes browsing the source code of IntelliJ helps understand platform details that aren't documented.
354354
355-
- In order to have the platform sources handy, clone the IntelliJ IDEA Community Edition repo
355+
- To have the platform sources handy, clone the IntelliJ IDEA Community Edition repo
356356
(`git clone https://github.com/JetBrains/intellij-community`)
357357
- Sync it to the same version of IntelliJ as given by `baseVersion` in gradle.properties (`git checkout 211.7628`).
358358
It will be in "detached HEAD" mode.
359-
- Open the Project Structure dialog (`File > Project Structure`). In the `IntelliJ IDEA Community Edition` sdk,
359+
- Open the Project Structure dialog (`File > Project Structure`). In the `IntelliJ IDEA Community Edition` SDK,
360360
head over to the `Sourcepaths` tab and add the path to `intellij-community`.
361361
Accept all the root folders found by the IDE after scanning.
362-
- Do the same for the intellij-plugins repo to get Dart plugin sources. Sync to the same version as before.
362+
- Do the same for the `intellij-plugins` repo to get Dart plugin sources. Sync to the same version as before.
363363
364364
## Working with Android Studio
365365
@@ -368,7 +368,7 @@ so it still needs the `flutter-intellij-community.iml` file.
368368
Obviously, unit tests can only be run from the command line.
369369
370370
1. Initialize Android Studio sources.
371-
2. Checkout Flutter plugin sources, tip of tree.
371+
2. Checkout Flutter plugin sources, tip of the tree.
372372
3. Follow the directions for setting up the Dart plugin sources in
373373
`intellij-plugins/Dart/README.md` with these changes:
374374
- you do not need to clone the intellij-community repo
@@ -379,10 +379,10 @@ Obviously, unit tests can only be run from the command line.
379379
- intellij-plugins/Dart/Dart-community.iml (if there are lots of errors, see step 7)
380380
- flutter-intellij/flutter-intellij-community.iml
381381
6. Using the Project Structure editor, expand the tree to show `intellij > android > adt > ui`.
382-
Select the `ui` module then add a module dependency from it to `flutter-intellij-community`.
383-
Also add a dependency on the Dart module unless using step 7.
382+
Select the `ui` module, then add a module dependency from it to `flutter-intellij-community`.
383+
Also, add a dependency on the Dart module unless using step 7.
384384
7. (Optional, when Dart sources are not usable.) Make sure the `flutter-intellij-community` module
385-
has a dependency on a library named `Dart`. It should be pre-defined, but if it is out-of-date
385+
has a dependency on a library named `Dart`. It should be pre-defined, but if it is out of date,
386386
then adjust it to point to `flutter-intellij/third_party/lib/dart-plugin/xxx.yyyy/Dart.jar`.
387387
Delete the Dart module from the Project Structure modules list.
388388
@@ -415,9 +415,9 @@ By default, the DevTools version in IntelliJ will match the DevTools version shi
415415
1. Make sure you have `dt` installed
416416
- Follow instructions in the [DevTools set-up guide](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md#set-up-your-devtools-environment)
417417
2. Set the registry key to your DevTools directory
418-
- Go to Help > Find action > Registry > Find "flutter.local.devtools.dir" and set to your DevTools directory. (e.g. Users/user/dev/devtools)
418+
- Go to Help > Find action > Registry > Find "flutter.local.devtools.dir" and set it to your DevTools directory. (e.g. Users/user/dev/devtools)
419419
- Optional: If you want to pass additional arguments to `dt serve`, put these in the option "flutter.local.devtools.args"
420420
3. Restart IntelliJ
421421
4. Open Help > Show log in finder > Open idea.log
422422
- Verify you see output like see output `"DevTools startup: <various messages that come from running dt serve>"`
423-
5. To stop using local DevTools, go back to the registry key set in step 2 and remove it
423+
5. To stop using local DevTools, go back to the registry key set in step 2 and remove it

0 commit comments

Comments
 (0)