You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update CONTRIBUTING.md to point to code-change-guide (#34384)
* Update CONTRIBUTING.md to point to code-change-guide
* Move java 8 to 11
* Fix a few markdown formatting issues
* Update CONTRIBUTING.md
Co-authored-by: Danny McCormick <[email protected]>
---------
Co-authored-by: Danny McCormick <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-44
Original file line number
Diff line number
Diff line change
@@ -40,12 +40,14 @@ These steps and instructions on getting started are outlined below as well.
40
40
41
41
- A [GitHub](https://github.com/) account.
42
42
- A Linux, macOS, or Microsoft Windows development environment.
43
-
- Java JDK 8 installed.
44
-
-[Go](https://golang.org) 1.16.0 or later installed.
43
+
- Java JDK 11 (preferred, or 8, 17, 21) installed.
44
+
-Latest [Go](https://golang.org) 1.x installed.
45
45
-[Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing changes to this website locally.
46
46
- For SDK Development:
47
-
- Python 3.x interpreters. You will need Python interpreters for all Python versions supported by Beam.
48
-
Interpreters should be installed and available in shell via `python3.x` commands. For more information, see:
47
+
- For manual testing install any version of supported Python version (found [here](gradle.properties)) suffices.
48
+
- For running test suites, however, you will need Python interpreters for all Python versions supported by Beam.
49
+
Interpreters should be installed and available in shell via `python3.x` commands.
50
+
For more information, see:
49
51
Python installation tips in [Developer Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters).
50
52
- For large contributions, a signed [Individual Contributor License.
51
53
Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
@@ -86,7 +88,7 @@ To install these in a Debian-based distribution:
86
88
1. Execute:
87
89
```
88
90
sudo apt-get install \
89
-
openjdk-8-jdk \
91
+
openjdk-11-jdk \
90
92
python-setuptools \
91
93
python-pip \
92
94
virtualenv \
@@ -115,7 +117,7 @@ You can install these in a Debian-based distribution for Linux or macOs using th
115
117
* pip3 packages
116
118
* go packages
117
119
* goavro
118
-
* JDK 8
120
+
* JDK 11
119
121
* Python
120
122
* Docker
121
123
@@ -188,44 +190,17 @@ Execute:
188
190
./gradlew :examples:java:wordCount
189
191
```
190
192
191
-
5. Familiarize yourself with gradle and the project structure.
192
-
193
-
At the root of the git repository, run:
194
-
```
195
-
$ ./gradlew projects
196
-
```
197
-
Examine the available tasks in a project. For the default set of tasks, use:
198
-
```
199
-
$ ./gradlew tasks
200
-
```
201
-
For a given module, use:
202
-
```
203
-
$ ./gradlew -p sdks/java/io/cassandra tasks
204
-
```
205
-
For an exhaustive list of tasks, use:
206
-
```
207
-
$ ./gradlew tasks --all
208
-
```
209
-
210
-
6. Make sure you can build and run tests.
211
-
212
-
Since Beam is a large project, usually, you will want to limit testing to the particular module you are working on. Gradle will build just the necessary things to run those tests. For example:
213
-
```
214
-
$ ./gradlew -p sdks/go check
215
-
$ ./gradlew -p sdks/java/io/cassandra check
216
-
$ ./gradlew -p runners/flink check
217
-
```
218
-
219
-
7. Now you may want to set up your preferred IDE and other aspects of your development
220
-
environment. See the Developers' wiki for tips, guides, and FAQs on:
0 commit comments