Contributing
Last updated
Was this helpful?
Last updated
Was this helpful?
Great to have you here. Here are a few ways you can help make kepler.gl even better!
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:
Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.
Use the -s or --signoff command line to append this automatically to your commit message:
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
that relates to your submission. You don't want to duplicate effort.
Make your changes in a new git branch:
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.