Skip to content

feat: add local_name and description fields for all countries, update CONTRIBUTING.md #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ankitgadling merged 2 commits into from
Oct 2, 2025
Merged

feat: add local_name and description fields for all countries, update CONTRIBUTING.md #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b5c8ae
feat: add local_name and description fields for all countries, update…
Meghana-2124 Oct 2, 2025
92ee3b4
feat: update schema.json to include local_name and description fields
Meghana-2124 Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

---
# Contributing to Postal Regex Repository

Thank you for your interest in contributing! 🎉
Thank you for your interest in contributing!
This guide will help you add new countries, maintain consistency, and ensure your contributions pass automated tests.

---
Expand All @@ -27,6 +26,8 @@ All country data is stored in `src/postal_regex/data/postal_codes.json`. Each en
* `postal_code_regex` → regex pattern for postal/pincode validation
* `sample_valid` → a valid postal code example for testing
* `sample_invalid` → an invalid postal code example for testing
* `local_name` → country name in local language
* `description` → brief description about postal codes

### Example Entry

Expand All @@ -36,7 +37,9 @@ All country data is stored in `src/postal_regex/data/postal_codes.json`. Each en
"country_name": "Germany",
"postal_code_regex": "^[0-9]{5}$",
"sample_valid": "10115",
"sample_invalid": "ABCDE"
"sample_invalid": "ABCDE",
"local_name": "Deutschland",
"description": "German postal codes (PLZ) are five digits; the first two digits denote the region."
}
```

Expand All @@ -46,6 +49,7 @@ All country data is stored in `src/postal_regex/data/postal_codes.json`. Each en
* Add one country per PR whenever possible for easier review.

---

## Creating an Issue

If you notice missing data, incorrect regex, or want to propose a new feature:
Expand Down
Loading