Merge pull request #30 from isaacbrodsky/contrib-docs

Add contributions docs

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to the H3 project
+
+Pull requests and Github issues are welcome!
+
+## 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.
+
+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.

README.md

@@ -140,7 +140,7 @@ Center coordinates: 40.689422, 285.955569
 
 ## Contributing
 
-Pull requests and Github issues are welcome. 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.
+Pull requests and Github issues are welcome. Please see our [contributing guide](./CONTRIBUTING.md) for more information.
 
 Before we can merge your changes, you must agree to the [Uber Contributor License Agreement](https://cla-assistant.io/uber/h3).
 

dev-docs/creating_bindings.md

@@ -0,0 +1,15 @@
+# Creating bindings for H3
+
+H3 is a C library, in part to make it simpler to create bindings for different programming languages. Each language usually has its own way to bind to C functions, but this document can serve as a starting point and list of tips.
+
+There may already be [H3 bindings](https://uber.github.io/h3/#/documentation/community/bindings) available for your language of choice. There are planned bindings for Java, Javascript, Python, and Go coming.
+
+## Function naming
+
+The `make binding-functions` target produces a file `binding-functions` containing a list of function in the H3 public API, one per line. You can use this as part of your build process to check how much of the H3 public API your bindings expose. This list does not include memory management functions that are needed to allocate arrays to be passed to the H3 API.
+
+Keeping similar names and purposes for functions can make it easier for your users to use the H3 [API Reference](https://uber.github.io/h3/#/documentation/api-reference/).
+
+## Community
+
+When ready, make a [pull request](https://github.com/uber/h3/edit/master/docs/community/bindings.md) to add your binding to the H3 documentation website.