Skip to content

Latest commit

 

History

History
168 lines (127 loc) · 7.1 KB

CONTRIBUTING.md

File metadata and controls

168 lines (127 loc) · 7.1 KB
Raw

Contributing

Thanks for your interest in contributing to the Earth Engine Community repository!

Please follow the guidance provided below to ensure a smooth process for all.

Issues

Before you begin work on your contribution, open an issue to let us know you intend to make a change and allow us to give early feedback.

We accept several contribution types; relevant issue templates include:

Provide enough information in the issue description for us to understand what you intend to add or change and why. If you've had correspondence with an Earth Engine team member regarding the issue, please mention them in the issue description using their GitHub handle preceded with "@" (for example, @gh-handle).

Contribution types

We welcome new content as well as edits to existing content. See the following content sections for any special instructions.

Tutorials

We accept Earth Engine tutorials as Markdown and Colab notebooks. These tutorials are published under the Community Tutorials section of the Earth Engine Developer's Guide. Please see our instructions on writing tutorials.

Explore tutorial directories and files.

Datasets

We accept scripts from partners collaborating with the Earth Engine Data team, including sample usage code and code for preparing data for ingestion and distribution.

Explore dataset directories and files.

Contributor License Agreement

Contributions to the Earth Engine Community repository must be accompanied by a Contributor License Agreement (CLA) that defines the terms under which intellectual property is contributed. Before you open your first pull request, please sign the Google CLA. If you have already signed the CLA, no further action is needed. Learn more about the Google CLA.

License headers

All files must include an Apache License, Version 2.0 header with the copyright given as The Google Earth Engine Community Authors. The following sections specify how the license should be formatted according to file type.

Markdown

<!--
Copyright 2021 The Google Earth Engine Community Authors

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.
-->

Python

# Copyright 2021 The Google Earth Engine Community Authors
#
# 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
#
# 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.

Colab notebook

Include the following block as a code cell.

#@title Copyright 2021 The Earth Engine Community Authors { display-mode: "form" }
#
# 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
#
# 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.

Pull Request process

  1. Fork the Earth Engine Community repository (if you have not already)
  2. Sync your fork to the main repo (if not a fresh fork)
  3. Make a branch for your changes
  4. Add or edit files
  5. Ensure new files include the proper license header
  6. Open a Pull Request (PR)
  7. Describe the PR using the provided PR template questions
  8. Submit the PR for review
  9. Make changes suggested by reviewer(s)
  10. The PR will typically be merged within one week of approval

Learn more about GitHub forks, syncing, branches, and Pull Requests.

We can also help you through this process in your issue thread.

Community guidelines

This project follows Google's Open Source Community Guidelines.

Code of conduct

The Earth Engine team is committed to fostering a welcoming community. Please familiarize yourself with our Code of Conduct before participating.