blob: 683326f770928e770f961509b2c44a975dacbbe5 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
# Contributing to the H3 project
Pull requests and Github issues are welcome!
Planned improvements and changes are listed on the [H3 Roadmap](https://github.com/uber/h3/wiki/Roadmap). Roadmap items are currently discussed in Github issues. Feel free to open a discussion about an existing roadmap item or proposing a new one.
## Pull requests
* Please include tests that show the bug is fixed or feature works as intended.
* Please add a description of your change to the Unreleased section of the [changelog](./CHANGELOG.md).
* Please open issues to discuss large features or changes which would break compatibility, before submitting pull requests.
* Please keep H3 compatible with major C compilers, such as GCC, Clang, and MSVC. We use clang-format-9 for source code formatting, if you have another version the CI job may error on formatting differences.
* Please keep code coverage of the core H3 library at 100%.
Before we can merge your changes, you must agree to the [Uber Contributor License Agreement](https://cla-assistant.io/uber/h3).
## Other ways to contribute
In addition to making pull requests and Github issues on the @uber/h3 repository, there are other ways you can contribute. Here are some suggestions:
* Writing and updating the [documentation website](./docs/).
* Writing [bindings](./dev-docs/creating_bindings.md) for your preferred language.
* Writing components so that your preferred GIS, mapping, or visualization system can display H3 indexes.
|
