[
https://issues.apache.org/jira/browse/AVRO-3523?focusedWorklogId=776280&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-776280
]
ASF GitHub Bot logged work on AVRO-3523:
----------------------------------------
Author: ASF GitHub Bot
Created on: 31/May/22 12:13
Start Date: 31/May/22 12:13
Worklog Time Spent: 10m
Work Description: martin-g commented on code in PR #1707:
URL: https://github.com/apache/avro/pull/1707#discussion_r885557732
##########
doc/content/en/project/How to contribute/_index.md:
##########
@@ -0,0 +1,287 @@
+---
+title: "How to contribute"
+linkTitle: "How to contribute"
+weight: 3
+---
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+## Getting the source code
+
+First of all, you need the Avro source code.
+
+The easiest way is to clone or fork the GitHub mirror:
+
+```shell
+git clone https://github.com/apache/avro.git -o github
+```
+
+
+## Making Changes
+
+Before you start, file an issue in
[JIRA](https://issues.apache.org/jira/browse/AVRO) or discuss your ideas on the
[Avro developer mailing list](http://avro.apache.org/mailing_lists.html).
Describe your proposed changes and check that they fit in with what others are
doing and have planned for the project. Be patient, it may take folks a while
to understand your requirements.
+
+Modify the source code and add some (very) nice features using your favorite
IDE.
+
+But take care about the following points
+
+**All Languages**
+- Contributions should pass existing unit tests.
+- Contributions should document public facing APIs.
+- Contributions should add new tests to demonstrate bug fixes or test new
features.
+
+**Java**
+
+- All public classes and methods should have informative [Javadoc
comments](https://www.oracle.com/fr/technical-resources/articles/java/javadoc-tool.html).
+- Do not use @author tags.
+- Java code should be formatted according to [Oracle's
conventions](https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html),
with one exception:
+ - Indent two spaces per level, not four.
+- [JUnit](http://www.junit.org/) is our test framework:
+- You must implement a class whose class name starts with Test.
+- Define methods within your class and tag them with the @Test annotation.
Call JUnit's many assert methods to verify conditions; these methods will be
executed when you run mvn test.
+- By default, do not let tests write any temporary files to /tmp. Instead, the
tests should write to the location specified by the test.dir system property.
+- Place your class in the src/test/java/ tree.
+- You can run all the unit tests with the command mvn test, or you can run a
specific unit test with the command mvn -Dtest=<class name, fully qualified or
short name> test (for example mvn -Dtest=TestFoo test)
+
+
+## Code Style (Autoformatting)
+
+For Java code we use [Spotless](https://github.com/diffplug/spotless/) to
format the code to comply with Avro's code style conventions (see above).
Automatic formatting relies on [Avro's Eclipse JDT formatter
definition](https://github.com/apache/avro/blob/master/lang/java/eclipse-java-formatter.xml).
You can use the same definition to auto format from Eclipse or from IntelliJ
configuring the Eclipse formatter plugin.
+
+If you use maven code styles issues are checked at the compile phase. If your
code breaks because of bad formatting, you can format it automatically by
running the command:
+```shell
+mvn spotless:apply
+```
+
+## Unit Tests
+
+Please make sure that all unit tests succeed before constructing your patch
and that no new compiler warnings are introduced by your patch. Each language
has its own directory and test process.
+
+<details><summary>Java</summary>
+
+```shell
+cd avro-trunk/lang/java
+mvn clean test
+```
+</details>
+
+<details><summary>Python</summary>
+
+```shell
+cd avro-trunk/lang/py
+ant clean test
Review Comment:
There is no `build.xml` for Ant.
Please replace with `./build test`.
Same for all langs, including Java.
##########
doc/content/en/project/How to contribute/_index.md:
##########
@@ -0,0 +1,287 @@
+---
+title: "How to contribute"
+linkTitle: "How to contribute"
+weight: 3
+---
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+## Getting the source code
+
+First of all, you need the Avro source code.
+
+The easiest way is to clone or fork the GitHub mirror:
+
+```shell
+git clone https://github.com/apache/avro.git -o github
+```
+
+
+## Making Changes
+
+Before you start, file an issue in
[JIRA](https://issues.apache.org/jira/browse/AVRO) or discuss your ideas on the
[Avro developer mailing list](http://avro.apache.org/mailing_lists.html).
Describe your proposed changes and check that they fit in with what others are
doing and have planned for the project. Be patient, it may take folks a while
to understand your requirements.
+
+Modify the source code and add some (very) nice features using your favorite
IDE.
+
+But take care about the following points
+
+**All Languages**
+- Contributions should pass existing unit tests.
+- Contributions should document public facing APIs.
+- Contributions should add new tests to demonstrate bug fixes or test new
features.
+
+**Java**
+
+- All public classes and methods should have informative [Javadoc
comments](https://www.oracle.com/fr/technical-resources/articles/java/javadoc-tool.html).
+- Do not use @author tags.
+- Java code should be formatted according to [Oracle's
conventions](https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html),
with one exception:
+ - Indent two spaces per level, not four.
+- [JUnit](http://www.junit.org/) is our test framework:
+- You must implement a class whose class name starts with Test.
+- Define methods within your class and tag them with the @Test annotation.
Call JUnit's many assert methods to verify conditions; these methods will be
executed when you run mvn test.
+- By default, do not let tests write any temporary files to /tmp. Instead, the
tests should write to the location specified by the test.dir system property.
+- Place your class in the src/test/java/ tree.
+- You can run all the unit tests with the command mvn test, or you can run a
specific unit test with the command mvn -Dtest=<class name, fully qualified or
short name> test (for example mvn -Dtest=TestFoo test)
+
+
+## Code Style (Autoformatting)
+
+For Java code we use [Spotless](https://github.com/diffplug/spotless/) to
format the code to comply with Avro's code style conventions (see above).
Automatic formatting relies on [Avro's Eclipse JDT formatter
definition](https://github.com/apache/avro/blob/master/lang/java/eclipse-java-formatter.xml).
You can use the same definition to auto format from Eclipse or from IntelliJ
configuring the Eclipse formatter plugin.
+
+If you use maven code styles issues are checked at the compile phase. If your
code breaks because of bad formatting, you can format it automatically by
running the command:
+```shell
+mvn spotless:apply
+```
+
+## Unit Tests
+
+Please make sure that all unit tests succeed before constructing your patch
and that no new compiler warnings are introduced by your patch. Each language
has its own directory and test process.
+
+<details><summary>Java</summary>
+
+```shell
+cd avro-trunk/lang/java
+mvn clean test
+```
+</details>
+
+<details><summary>Python</summary>
+
+```shell
+cd avro-trunk/lang/py
+ant clean test
+```
+</details>
+
+<details><summary>Python3</summary>
+
+```shell
+cd avro-trunk/lang/py3
+./setup.py build test
+```
+</details>
+
+<details><summary>C</summary>
+
+```shell
+cd avro-trunk/lang/c
+./build.sh clean
+./build.sh test
+```
+</details>
+
+<details><summary>C++</summary>
+
+```shell
+cd avro-trunk/lang/c++
+./build.sh clean test
+```
+</details>
+
+<details><summary>Ruby</summary>
+
+```shell
+cd avro-trunk/lang/ruby
+gem install echoe
+rake clean test
+```
+</details>
+
+<details><summary>PHP</summary>
Review Comment:
Please add an entry for `lang/rust` too.
##########
doc/content/en/project/How to contribute/_index.md:
##########
@@ -0,0 +1,287 @@
+---
+title: "How to contribute"
+linkTitle: "How to contribute"
+weight: 3
+---
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+## Getting the source code
+
+First of all, you need the Avro source code.
+
+The easiest way is to clone or fork the GitHub mirror:
+
+```shell
+git clone https://github.com/apache/avro.git -o github
+```
+
+
+## Making Changes
+
+Before you start, file an issue in
[JIRA](https://issues.apache.org/jira/browse/AVRO) or discuss your ideas on the
[Avro developer mailing list](http://avro.apache.org/mailing_lists.html).
Describe your proposed changes and check that they fit in with what others are
doing and have planned for the project. Be patient, it may take folks a while
to understand your requirements.
+
+Modify the source code and add some (very) nice features using your favorite
IDE.
+
+But take care about the following points
+
+**All Languages**
+- Contributions should pass existing unit tests.
+- Contributions should document public facing APIs.
+- Contributions should add new tests to demonstrate bug fixes or test new
features.
+
+**Java**
+
+- All public classes and methods should have informative [Javadoc
comments](https://www.oracle.com/fr/technical-resources/articles/java/javadoc-tool.html).
+- Do not use @author tags.
+- Java code should be formatted according to [Oracle's
conventions](https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html),
with one exception:
+ - Indent two spaces per level, not four.
+- [JUnit](http://www.junit.org/) is our test framework:
+- You must implement a class whose class name starts with Test.
+- Define methods within your class and tag them with the @Test annotation.
Call JUnit's many assert methods to verify conditions; these methods will be
executed when you run mvn test.
+- By default, do not let tests write any temporary files to /tmp. Instead, the
tests should write to the location specified by the test.dir system property.
+- Place your class in the src/test/java/ tree.
+- You can run all the unit tests with the command mvn test, or you can run a
specific unit test with the command mvn -Dtest=<class name, fully qualified or
short name> test (for example mvn -Dtest=TestFoo test)
+
+
+## Code Style (Autoformatting)
+
+For Java code we use [Spotless](https://github.com/diffplug/spotless/) to
format the code to comply with Avro's code style conventions (see above).
Automatic formatting relies on [Avro's Eclipse JDT formatter
definition](https://github.com/apache/avro/blob/master/lang/java/eclipse-java-formatter.xml).
You can use the same definition to auto format from Eclipse or from IntelliJ
configuring the Eclipse formatter plugin.
+
+If you use maven code styles issues are checked at the compile phase. If your
code breaks because of bad formatting, you can format it automatically by
running the command:
+```shell
+mvn spotless:apply
+```
+
+## Unit Tests
+
+Please make sure that all unit tests succeed before constructing your patch
and that no new compiler warnings are introduced by your patch. Each language
has its own directory and test process.
+
+<details><summary>Java</summary>
+
+```shell
+cd avro-trunk/lang/java
+mvn clean test
+```
+</details>
+
+<details><summary>Python</summary>
+
+```shell
+cd avro-trunk/lang/py
+ant clean test
+```
+</details>
+
+<details><summary>Python3</summary>
+
+```shell
+cd avro-trunk/lang/py3
Review Comment:
there is no `py3`
##########
doc/content/en/project/How to contribute/_index.md:
##########
@@ -0,0 +1,287 @@
+---
+title: "How to contribute"
+linkTitle: "How to contribute"
+weight: 3
+---
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+## Getting the source code
+
+First of all, you need the Avro source code.
+
+The easiest way is to clone or fork the GitHub mirror:
+
+```shell
+git clone https://github.com/apache/avro.git -o github
+```
+
+
+## Making Changes
+
+Before you start, file an issue in
[JIRA](https://issues.apache.org/jira/browse/AVRO) or discuss your ideas on the
[Avro developer mailing list](http://avro.apache.org/mailing_lists.html).
Describe your proposed changes and check that they fit in with what others are
doing and have planned for the project. Be patient, it may take folks a while
to understand your requirements.
+
+Modify the source code and add some (very) nice features using your favorite
IDE.
+
+But take care about the following points
+
+**All Languages**
+- Contributions should pass existing unit tests.
+- Contributions should document public facing APIs.
+- Contributions should add new tests to demonstrate bug fixes or test new
features.
+
+**Java**
+
+- All public classes and methods should have informative [Javadoc
comments](https://www.oracle.com/fr/technical-resources/articles/java/javadoc-tool.html).
+- Do not use @author tags.
+- Java code should be formatted according to [Oracle's
conventions](https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html),
with one exception:
+ - Indent two spaces per level, not four.
+- [JUnit](http://www.junit.org/) is our test framework:
+- You must implement a class whose class name starts with Test.
+- Define methods within your class and tag them with the @Test annotation.
Call JUnit's many assert methods to verify conditions; these methods will be
executed when you run mvn test.
+- By default, do not let tests write any temporary files to /tmp. Instead, the
tests should write to the location specified by the test.dir system property.
+- Place your class in the src/test/java/ tree.
+- You can run all the unit tests with the command mvn test, or you can run a
specific unit test with the command mvn -Dtest=<class name, fully qualified or
short name> test (for example mvn -Dtest=TestFoo test)
+
+
+## Code Style (Autoformatting)
+
+For Java code we use [Spotless](https://github.com/diffplug/spotless/) to
format the code to comply with Avro's code style conventions (see above).
Automatic formatting relies on [Avro's Eclipse JDT formatter
definition](https://github.com/apache/avro/blob/master/lang/java/eclipse-java-formatter.xml).
You can use the same definition to auto format from Eclipse or from IntelliJ
configuring the Eclipse formatter plugin.
+
+If you use maven code styles issues are checked at the compile phase. If your
code breaks because of bad formatting, you can format it automatically by
running the command:
+```shell
+mvn spotless:apply
+```
+
+## Unit Tests
+
+Please make sure that all unit tests succeed before constructing your patch
and that no new compiler warnings are introduced by your patch. Each language
has its own directory and test process.
+
+<details><summary>Java</summary>
+
+```shell
+cd avro-trunk/lang/java
+mvn clean test
+```
+</details>
+
+<details><summary>Python</summary>
+
+```shell
+cd avro-trunk/lang/py
+ant clean test
+```
+</details>
+
+<details><summary>Python3</summary>
+
+```shell
+cd avro-trunk/lang/py3
+./setup.py build test
+```
+</details>
+
+<details><summary>C</summary>
+
+```shell
+cd avro-trunk/lang/c
+./build.sh clean
+./build.sh test
+```
+</details>
+
+<details><summary>C++</summary>
+
+```shell
+cd avro-trunk/lang/c++
+./build.sh clean test
+```
+</details>
+
+<details><summary>Ruby</summary>
+
+```shell
+cd avro-trunk/lang/ruby
+gem install echoe
+rake clean test
+```
+</details>
+
+<details><summary>PHP</summary>
+
+```shell
+cd avro-trunk/lang/php
+./build.sh clean
+./build.sh test
+```
+
+</details>
+
+<details><summary>Documentation</summary>
+
+Please also check the documentation.
+Java
+
+```shell
+mvn compile
+mvn javadoc:aggregate
+firefox target/site/apidocs/index.html
+```
+
+Examine all public classes you've changed to see that documentation is
complete, informative, and properly formatted. Your patch must not generate any
javadoc warnings.
+</details>
+
+## Contributing your code
+
+Contribution can be made directly via github with a Pull Request, or via a
patch.
+
+**Via Github**
+
+Method is to create a [pull
request](https://help.github.com/articles/using-pull-requests/).
+
+On your fork, create a branch named with JIRA (avro-1234_fixNpe for example)
+On source, go to it
+```shell
+git pull
+git switch avro-1234_fixNpe
+```
+
+code your changes (following preceding recommendations)
+
+check and add updated sources
+```shell
+git status
+
+# Add any new or changed files with:
+git add src/.../MyNewClass.java
+git add src/.../TestMyNewClass.java
+```
+
+Finally, create a commit with your changes and a good log message, and push it:
+```shell
+git commit -m "AVRO-1234: Fix NPE by adding check to ..."
+git push
+```
+On your github fork site, a button will propose you to build the Pull Request.
+Click on it, fill Conversation form, and create it.
+Link this PR to the corresponding JIRA ticket (on JIRA ticket, add PR to
"Issue Links" chapter, and add label 'pull-request-available' to it .
+
+
+<details><summary><b>Via Patch</b> (if you don't have github account)</summary>
+<blockquote>
+<details><summary><b>Clone avro repository</b></summary>
+
+```shell
+git clone https://github.com/apache/avro.git
Review Comment:
append `-o github` for consistency with the earlier clone sample
Issue Time Tracking
-------------------
Worklog Id: (was: 776280)
Remaining Estimate: 0h
Time Spent: 10m
> How to contribute : remove patch section
> ----------------------------------------
>
> Key: AVRO-3523
> URL: https://issues.apache.org/jira/browse/AVRO-3523
> Project: Apache Avro
> Issue Type: Task
> Components: community
> Reporter: Christophe Le Saec
> Assignee: Christophe Le Saec
> Priority: Trivial
> Labels: documentation, pull-request-available
> Time Spent: 10m
> Remaining Estimate: 0h
>
> The page [how to
> contribute|https://cwiki.apache.org/confluence/display/AVRO/How+To+Contribute#HowToContribute-CommittingGuidelinesforcommitters]
> contains description to patch but PR is enough.
> The aim of this JIRA is to remove patch from website.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
