Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.64 KB
Raw

Contributing to GeoFlink

The GeoFlink project welcomes contributions. You can contribute to GeoFlink code by making Pull Requests on GeoFlink github repository

The following sections brief the workflow of how to complete a contribution.

Develop a code contribution

Code contributions should include the following:

  • Detailed documentations on classes and methods.
  • Updates on corresponding GeoFlink documentation if necessary.

Code contributions must include a license header at the top of each file. A sample header for Scala/Java files is as follows:

/*  
Copyright 2020 Data Platform Research Team, AIRC, AIST, Japan  
  
Licensed 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  
  
http://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.  
*/

Make a Pull Request

After developing a contribution, the easiest way to push a contribution is to submit a Pull Request to the GeoFlink github repository

When preparing a pull request, please mentione what changes were proposed in this pull request.

When a pull request is submitted, we will check the build correctness. Please check the pull request status, and fix any reported problems.