Skip to content

Commit c276c98

Browse files
committed
add note about including the repo as a submodule
1 parent 732c666 commit c276c98

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,12 @@ There are open-source implementations in
6666
* [Scala](https://github.com/ben-willis/address-formatter)
6767

6868
We would love more language implementations. The more people who use the templates, the more likely bugs will be reported.
69-
If you write a processor, please submit a pull request adding it to the list. Thanks.
69+
70+
If you write a processor, please submit a pull request adding your processor to the list.
71+
72+
One key point: please include this repo as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so we all use the same templates/configuration and don't get out of sync. if you are unfamiliar with git submodules, please have a look at [how we do it in the Perl parser](https://github.com/OpenCageData/perl-Geo-Address-Formatter/blob/master/README.md#installation).
73+
74+
Thanks!
7075

7176
### International coverage
7277

0 commit comments

Comments
 (0)