1-
21---
32# Contributing to Postal Regex Repository
43
5- Thank you for your interest in contributing! 🎉
4+ Thank you for your interest in contributing!
65This guide will help you add new countries, maintain consistency, and ensure your contributions pass automated tests.
76
87---
@@ -27,6 +26,8 @@ All country data is stored in `src/postal_regex/data/postal_codes.json`. Each en
2726* ` postal_code_regex ` → regex pattern for postal/pincode validation
2827* ` sample_valid ` → a valid postal code example for testing
2928* ` sample_invalid ` → an invalid postal code example for testing
29+ * ` local_name ` → country name in local language
30+ * ` description ` → brief description about postal codes
3031
3132### Example Entry
3233
@@ -36,7 +37,9 @@ All country data is stored in `src/postal_regex/data/postal_codes.json`. Each en
3637 "country_name" : " Germany" ,
3738 "postal_code_regex" : " ^[0-9]{5}$" ,
3839 "sample_valid" : " 10115" ,
39- "sample_invalid" : " ABCDE"
40+ "sample_invalid" : " ABCDE" ,
41+ "local_name" : " Deutschland" ,
42+ "description" : " German postal codes (PLZ) are five digits; the first two digits denote the region."
4043}
4144```
4245
@@ -46,6 +49,7 @@ All country data is stored in `src/postal_regex/data/postal_codes.json`. Each en
4649* Add one country per PR whenever possible for easier review.
4750
4851---
52+
4953## Creating an Issue
5054
5155If you notice missing data, incorrect regex, or want to propose a new feature:
0 commit comments