The Open Location Code project strongly encourages technical contributions.
We hope you'll become an ongoing participant in our open source community, but we also welcome one-off contributions for the issues you're particularly passionate about.
- Filing issues
- Contributing code
- Contributing a new implementation
- Contributor License Agreement
- Ongoing participation
If you find a bug in an Open Location Code library, please file an issue. Members of the community are regularly monitoring issues and will try to fix open bugs quickly.
The best bug reports provide a detailed description of the issue, step-by-step instructions for predictably reproducing the issue, and possibly even a working example that demonstrates the issue.
Please note that questions about how to use Open Location Code or other general questions should be asked on the Open Location Code Google Group instead of filing an issue here.
The Open Location Code project is meant to evolve with feedback. The project and its users appreciate your thoughts on ways to improve the design or features or creative ways to use the codes.
To make a suggestion file an issue.
If you are intending to implement, please see the Contributing code section below for next steps.
If you are adding Open Location Codes to your project, please contact the Open Location Code Google Group so we can suggest how you can make the most of the codes.
The Open Location Code project accepts and greatly appreciates code contributions!
A few things to note:
- The Open Location Code project follows the fork & pull model for accepting contributions.
- We follow Google's JavaScript Style Guide. More generally make sure to follow the same comment and coding style as the rest of the project.
- Include tests when contributing code. There are tests that you can use as examples.
If you have an implementation in your own repository, that's great! Just add a link to it in our wiki.
Follow this process for contributing a new implementation:
- Look at the existing implementations, to get an idea of the usage and how much work is involved.
- If you copy the code structure and algorithms from an existing implementation, you'll have a much shorter review cycle.
- Create a new GitHub issue to start discussion of the new feature.
- Follow the guidelines for Contributing code described above.
The Open Location Code project hosted at GitHub requires all contributors to sign a Contributor License Agreement (individual or corporation) in order to protect contributors, users and Google in issues of intellectual property.
When you create a Pull Request, a check will be run to ensure that you have signed the CLA. Make sure that you sign the CLA with the same email address you associate with your commits (likely via the user.email Git config as described on GitHub's Set up Git page).
We actively encourage ongoing participation by community members.
Technical issues, designs, etc. are discussed on GitHub issues and pull requests, or the Open Location Code Google Group.