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: README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ _Please note: the list is simple all officially assigned [ISO 3166-1 alpha-2 cod
87
87
88
88
### File format
89
89
90
-
The files are in [YAML](http://yaml.org/) format. The templates are written in [Mustache](http://mustache.github.io/). Both formats are human readable, strict, solve escaping and support comments. YAML allows references (called "ankers") to avoid copy&paste, Mustache allows sub-templates (called "partials").
90
+
The files are in [YAML](http://yaml.org/) format. The templates are written in [Mustache](http://mustache.github.io/) with a minor variation: the `{#first}` sections will take the first alternative for which a variable could be interpolated. Both formats are human readable, strict, solve escaping and support comments. YAML allows references (called "ankers") to avoid copy&paste, Mustache allows sub-templates (called "partials").
91
91
92
92
### How to add your country/territory
93
93
@@ -101,14 +101,15 @@ The files are in [YAML](http://yaml.org/) format. The templates are written in [
101
101
102
102
2. edit `conf/countries/worldwide.yaml`
103
103
* Possibly your country/territory uses an existing generic format as
104
-
defined at the top of the file. If so, great, just map you
104
+
defined at the top of the file. If so, great! Just map your
105
105
country_code to the generic template. You may still want to add
106
106
clean up code (see the entry for `DE` as an example).
107
-
* If not you need to define a new generic rule set
108
-
* possibly you will need to define new state/region mappings in `conf/state_codes.yaml`
107
+
* If not, you need to define a new rule set (may or may not be generic)
108
+
* You may also need to define new state/region mappings in `conf/state_codes.yaml`
109
109
110
-
3. to test you will now need to process the .yaml test via a processer
110
+
3. to test you will now need to process the .yaml test via a processor
111
111
(see above) and ensure the input leads to the desired output.
112
+
We also run these checks automatically against pull requests to ensure against regressions.
112
113
113
114
If in doubt, please get in touch by submitting an issue.
0 commit comments