Skip to content

Commit 1a604dd

Browse files
authored
Edit contributing for typos and some notes from setup (#8154)
1 parent 6afae9d commit 1a604dd

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

CONTRIBUTING.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
7777
```
7878
In your shell configuration file (e.g. `.bashrc` or `.zshrc`), set your `JAVA_HOME` env variable to match that version.
7979
```shell
80-
export JAVA_HOME=`/usr/libexec/java_home -v 23.0.2
80+
export JAVA_HOME=`/usr/libexec/java_home -v 23.0.2`
8181
```
8282

8383
3. Set your `FLUTTER_SDK` path in the configuration file for your shell environment.
@@ -98,13 +98,13 @@ name and contact info to the [AUTHORS](AUTHORS) file.
9898
4. Set your `DARK_SDK` path in the configuration file for your shell environment.
9999
- 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.
100100
```shell
101-
export DART_SDK="$HOME/path/to/flutter/bin/cache/dart-sdk`"
101+
export DART_SDK="$HOME/path/to/flutter/bin/cache/dart-sdk"
102102
```
103103

104104
5. Add `DART_SDK`, `FLUTTER_SDK` and `JAVA_HOME` to your `PATH`.
105105
- In your shell configuration file (e.g. `.bashrc` or `.zshrc`), below where your `JAVA_HOME`, `FLUTTER_SDK`, `DART_SDK` env variables were set, add the following line:
106106
```shell
107-
export PATH=$DART_SDK/bin:$FLUTTER_SDK/bin:$JAVA_HOME/bin:$PATH"
107+
export PATH=$DART_SDK/bin:$FLUTTER_SDK/bin:$JAVA_HOME/bin:$PATH
108108
```
109109

110110
6. Update your current `PATH`.
@@ -150,6 +150,7 @@ name and contact info to the [AUTHORS](AUTHORS) file.
150150
- `dart pub get`
151151
- `(cd tool/plugin; dart pub get)`
152152
- `bin/plugin test`
153+
- Note: If there are Dart errors during build originating in the `tool/plugin` directory, try deleting the contents of the `pubspec.lock` file and re-running the pub get steps. This will allow you to get a fresh set of pub packages.
153154

154155
### Configure "Project Structure" settings
155156

@@ -263,7 +264,7 @@ A problem occurred configuring project ':flutter-idea'.
263264
> Source directory 'X:\path\to\your\flutter-intellij\flutter-idea\resources' is not a directory.
264265
```
265266
266-
Check out if the directory is a symlink by open the link in IDEA, and it'll display as:
267+
Check if the directory is a symlink by opening the link in IDEA, and it'll display as:
267268
268269
```symlink
269270
../resources
@@ -275,8 +276,8 @@ Delete the file, then re-clone the repo using the below command:
275276
git clone -c core.symlinks=true https://github.com/<your_name_here>/flutter-intellij
276277
```
277278
278-
**NOTE**: Avoid symlinks addition during development as possible as you can,
279-
since they can lead to various of file-based issues during the development.
279+
**NOTE**: Avoid adding symlinks during development if you can,
280+
since they can lead to various file-based issues during development.
280281
281282
## Provision Tool
282283

0 commit comments

Comments
 (0)