LogoLogo
  • Welcome
  • What's new?
  • Docs
    • User guides
      • Get Started
      • Kepler.gl workflow
        • Add data to layers
          • Adding Data Layers
          • Create a Layer
          • Blend and Rearrange Layers
          • Hide, Edit and Delete Layers
        • Add Data to the Map
      • Layers
        • Point
        • S2 Layer
        • Icon
        • Line
        • Cluster
        • Polygon
        • Hexbin
        • Grid
        • H3
        • Heatmap
        • Arc
        • Trip layer
      • Layer Attributes
      • Color Palettes
      • Filters
      • Map Styles
      • Interactions
      • Map Settings
      • Time Playback
      • Save and Export
      • FAQ
    • API Reference
      • ecosystem
      • Get Started
      • Advanced usages
        • Saving and Loading Maps with Schema Manager
        • Replace UI Component with Component Dependency Injection
        • Forward Dispatch Actions
        • Reducer Plugin
        • Using Updaters
        • Custom reducer initial state
        • custom-mapbox-host
      • Components
      • Reducers
        • reducers
        • map-style
        • map-state
        • combine
        • overview
        • ui-state
        • vis-state
      • Processors
        • All processors
      • Schemas
      • Actions
        • All actions
      • Cloud providers
        • Provider
      • Custom theme
      • Localization
    • Jupyter Notebook
  • Examples
    • Node/Express
    • Demo App
    • Open modal
    • Open modal
    • UMD client
    • Customize kepler.gl Theme
    • Customize kepler.gl Reducer
  • Contributing
    • Developing Kepler.gl
    • Contributor Covenant Code of Conduct
  • Change Log
  • Upgrade Guide
Powered by GitBook
On this page
  • CONTRIBUTING
  • Developer Certification of Origin (DCO)
  • Code of Conduct
  • Questions and Problems
  • Issues and Bugs
  • Feature Requests
  • Improving Documentation
  • Submitting Pull Request

Was this helpful?

Contributing

PreviousCustomize kepler.gl ReducerNextDeveloping Kepler.gl

Last updated 5 years ago

Was this helpful?

CONTRIBUTING

Great to have you here. Here are a few ways you can help make kepler.gl even better!

Developer Certification of Origin (DCO)

When committing code, kepler.gl requires process to be followed.

The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

DCO Sign-Off Methods

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

Signed-off-by: Shan He <heshan0131@gmail.com>

Use the -s or --signoff command line to append this automatically to your commit message:

$ git commit -s -m 'This is my commit message'

Code of Conduct

Questions and Problems

Issues and Bugs

Feature Requests

If you would like to implement a new feature then consider what kind of change it is:

  • Pick your item Pick an item to execute

  • Claim the item Reply in the ticket linked in the roadmap to claim the item, one of the member of the technical team will respond

  • Major Changes that you wish to contribute to the project should be discussed first in an

    [GitHub issue][github-issues] that clearly outlines the changes and benefits of the feature.

  • Let's review your code Create a pull request

Improving Documentation

Submitting Pull Request

  • that relates to your submission. You don't want to duplicate effort.

  • Make your changes in a new git branch:

$ git checkout -b my-fix-branch master
  • Create your patch commit, including appropriate test cases.

  • Commit your changes using a descriptive commit message that follows our

Help us keep kepler.gl open and inclusive. Please read and follow our .

We are trying to keep our Github page for issues, bugs and feature requests only. You've got much better chances of getting supports on . Many people including our engineers are ready to answer questions on Stack Overflow. Your question might already been answered there.

If you find a bug, you can help us by submitting an to our GitHub Repository. Please use the github and fill in as much as information as possible. Even better, you can submit a with a fix.

If you want to contribute or add new features, please use on github projects to start a new discussion using the . If this receive a Go ahead, you can submit your patch as PR to the repository.

Take a look at our It lists out the items we are planning to work on

Small Changes can directly be crafted and submitted to the

as a Pull Request. See the section about , and

for detailed information the .

Questions about kepler.gl? you can checkout the examples and medium articles on .

and API Docs are saved in the folder on Github. Help us improve documentation here by submitting a Pull Request.

First, follow the for detailed guidance on environment setup, code style, testing and commit message conventions.

Search for an open or closed Pull Request

Create the

If the changes affect public APIs, change or add relevant .

Run , and ensure that all tests pass.

. Adherence to the conventions is required, because release notes are automatically generated from these messages.

Code of Conduct
Stack Overflow
Issue
Bug Report Template
Pull Request
Issue
Feature Request Template
roadmap
GitHub Repository
core development documentation
kepler.gl
User Guides
docs
development documentation
GitHub
Developer Certificate of Origin (DCO)
Developer Certification of Origin (DCO)
Code of Conduct
Questions and Problems
Issues and Bugs
Feature Requests
Improving Documentation
Submitting Pull Request
Pull Request Submission Guidelines
development environment
documentation
tests
commit message conventions