diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..09423a1b --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,37 @@ +Hi! + +I was checking out the awesome libpostal, and saw something that could be improved. + +--- +#### My country is + + +--- +#### Here's how I'm using libpostal + + +--- +#### Here's what I did + + +--- +#### Here's what I got + + +--- +#### Here's what I was expecting + + +--- +#### For parsing issues, please check all that apply + +- [ ] Does the input address exist in [OpenStreetMap](https://openstreetmap.org)? +- [ ] Do all the toponyms exist in OSM (city, state, region names, etc.)? +- [ ] If the address uses a rare/uncommon format, does changing the order of the fields yield the correct result? +- [ ] If the address does not contain city, region, etc., does adding those fields to the input improve the result? +- [ ] If the address contains apartment/floor/sub-building information or uncommon formatting, does removing that help? Is there any minimum form of the address that gets the right parse? + +--- +#### Here's what I think could be improved + +