You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-17Lines changed: 25 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,22 @@ The Open Location Code project strongly encourages technical contributions.
4
4
5
5
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.
6
6
7
-
-[Filing issues](#filing-issues)
8
-
*[Bugs](#bugs)
9
-
*[Suggestions](#suggestions)
10
-
-[Contributing code](#contributing-code)
11
-
-[Contributing a new implementation](#contributing-a-new-implementation)
If you find a bug in an Open Location Code library, please [file an issue](https://github.com/google/open-location-code/issues/new). Members of the community are regularly monitoring issues and will try to fix open bugs quickly.
21
+
If you find a bug in an Open Location Code library, please [file an issue](https://github.com/google/open-location-code/issues/new).
22
+
Members of the community are regularly monitoring issues and will try to fix open bugs quickly.
21
23
22
24
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.
23
25
@@ -26,7 +28,8 @@ instead of filing an issue here.
26
28
27
29
### Suggestions
28
30
29
-
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.
31
+
The Open Location Code project is meant to evolve with feedback.
32
+
The project and its users appreciate your thoughts on ways to improve the design or features or creative ways to use the codes.
30
33
31
34
To make a suggestion [file an issue](https://github.com/google/open-location-code/issues/new).
32
35
@@ -41,26 +44,31 @@ The Open Location Code project accepts and greatly appreciates code contribution
41
44
A few things to note:
42
45
43
46
* The Open Location Code project follows the [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) model for accepting contributions.
44
-
* We follow [Google's JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html). More generally make sure to follow the same comment and coding style as the rest of the project.
45
-
* Do not try to address multiple issues in a single pull request. In some cases, you might even resolve a single issue with multiple PRs (e.g. if you are changing multiple implementations).
46
-
* Include [tests](TESTING.md) when contributing code. There are tests that you can use as examples.
47
+
* We follow [Google's JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html).
48
+
More generally make sure to follow the same comment and coding style as the rest of the project.
49
+
* Do not try to address multiple issues in a single pull request.
50
+
In some cases, you might even resolve a single issue with multiple PRs (e.g. if you are changing multiple implementations).
51
+
* Include [tests](TESTING.md) when contributing code.
52
+
There are tests that you can use as examples.
47
53
48
54
## Contributing a new implementation
49
55
50
-
If you have an implementation in your own repository, that's great! Just add a link to it in our [wiki](https://github.com/google/open-location-code/wiki/Other-Implementations).
51
-
52
-
Follow this process for contributing a new implementation:
56
+
If you have an implementation in your own repository, that's great!
57
+
Unfortunately we can't accept implementations in languages we're not familiar with as we won't be able to maintain or test them.
58
+
You can add a link to it in our [list of external implementations](Documentation/External_Implementations.md).
53
59
54
60
* Look at the existing implementations, to get an idea of the usage and how much work is involved.
55
61
* If you copy the code structure and algorithms from an existing implementation, you'll have a much shorter review cycle.
56
62
*[Create a new GitHub issue](https://github.com/google/open-location-code/issues/new) to start discussion of the new feature.
57
63
* Follow the guidelines for [Contributing code](#contributing-code) described above.
64
+
* Don't forget to add tests!
58
65
59
66
## Contributor License Agreement
60
67
61
68
The Open Location Code project hosted at GitHub requires all contributors to sign a Contributor License Agreement ([individual](https://developers.google.com/open-source/cla/individual) or [corporation](https://developers.google.com/open-source/cla/corporate)) in order to protect contributors, users and Google in issues of intellectual property.
62
69
63
-
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](https://help.github.com/articles/set-up-git/) page).
70
+
When you create a Pull Request, a check will be run to ensure that you have signed the CLA.
71
+
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](https://help.github.com/articles/set-up-git/) page).
Copy file name to clipboardExpand all lines: Documentation/Reference/App_Developers.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
This page gives guidelines for how to support plus codes in a website or mapping application.
4
4
These guidelines should make it clear that adding support for OLC is not onerous, but actually quite easy.
5
5
6
-
> Note that with the availability of the [pluscodes API](https://github.com/google/open-location-code/wiki/Plus-code-API), these instructions really only apply to apps that require offline support.
6
+
> Note that with the availability of the [https://plus.codeswebsite API](plus.codes_Website_API.md), these instructions really only apply to apps that require offline support.
7
7
If your app or site can rely on a network connection, integrating with the API will give a better solution.
Copy file name to clipboardExpand all lines: Documentation/Reference/comparison.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ Open Post Codes <<openpostcode-site>> can be defined globally or within a contai
153
153
Codes, but codes defined within a country are shorter than full Open
154
154
Location Codes, and a similar length to short Open Location Codes.
155
155
156
-
Four countries are defined: Ireland, Hong Kong, Yemen and India.
156
+
Four countries are defined: Ireland, Hong Kong, Yemen and India.
157
157
158
158
Every location on the planet has a global code. Locations within the
159
159
countries where Open Post Code has been defined also have a local code.
@@ -249,7 +249,7 @@ information such as contact details, photos etc in addition to the location.
249
249
250
250
We felt that the attributes of the above systems didn't sufficiently meet
251
251
our requirements. As a result, we defined a new coding system and termed it
252
-
Open Location Code; codes created using this system are referred to as 'plus codes' (see the link:https://github.com/google/open-location-code/wiki/Naming-Guidelines[Naming Guidelines]).
252
+
Open Location Code; codes created using this system are referred to as 'plus codes' (see the link:../Specification/Naming_Guidelines.md[Naming Guidelines]).
253
253
254
254
Plus codes are 10 to 11 characters long. They can also be used in a
255
255
short form of four to seven characters, similar to telephone numbers and
Copy file name to clipboardExpand all lines: TESTING.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Testing
2
-
The preferred mechanism for testing is using the [Bazel](https://bazel.build/) build system. This uses files called `BUILD` ([example](https://github.com/google/open-location-code/blob/master/BUILD) to provide rules to build code and run tests).
2
+
The preferred mechanism for testing is using the [Bazel](https://bazel.build/) build system. This uses files called `BUILD` ([example](https://github.com/google/open-location-code/blob/main/python/BUILD) to provide rules to build code and run tests).
3
3
4
4
Create a `BUILD` file in your code directory with a [test rule](https://bazel.build/versions/master/docs/test-encyclopedia.html).
5
5
You can then test your code by running:
@@ -57,7 +57,7 @@ An example of a language using bazel is Python:
Copy file name to clipboardExpand all lines: js/closure/README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Included is a `BUILD` file that uses the [Bazel](https://bazel.build/) build sys
33
33
34
34
The tests use the [Closure Rules for Basel](https://github.com/bazelbuild/rules_closure) project although this is retrieved automatically and you don't have to install anything.
35
35
36
-
The test cases have been copied from the [`test_data`](https://github.com/google/open-location-code/tree/master/test_data) directory due to restrictions on loading data files within the test runner.
36
+
The test cases have been copied from the [`test_data`](https://github.com/google/open-location-code/blob/main/test_data) directory due to restrictions on loading data files within the test runner.
37
37
38
38
Run the tests from the top-level github directory with:
0 commit comments