Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/restructure_i18nify' into geo-sd…
Browse files Browse the repository at this point in the history 
…k-go
  • Loading branch information
@debanshurout
debanshurout committed Mar 5, 2024
2 parents c0c6bc4 + 5e87d84 commit 51178e7
Show file tree
Hide file tree
Showing 60 changed files with 321,626 additions and 91 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/i18nify-data-validate.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: i18nify Data Validation

on:
pull_request:
branches:
- master
types: [opened, synchronize]

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Setup Node.js
uses: actions/setup-node@v2

- name: Install dependencies
run: npm install

- name: Get changed files
run:
git diff --name-only origin/master >> changed_files.txt

- name: Compile TypeScript
run: npm run validate-i18nify-data changed_files.txt
58 changes: 58 additions & 0 deletions data/contribution-guidelines.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# i18nify-data Contribution Guidelines

Thank you for contributing to i18nify-data! 🎉

Please go through the below document before addition, deletion or updation of data and provide necessary information, to ensure you've reviewed this document to provide us with the necessary details for a prompt response
## Before Contributing

Before contributing a new data or the modifications to the existing data, please go through previous versions of data and ensure the modification that you're providing is never addressed.

### Source Reliability

There is no specific standards to specify that a source is standard as the data is very vast. But there are some factors that can be considered which make the source more reliable.

They are:

* The source is released by the government.
* The source is released by any esteemed organisation.
* The data is being updated periodically and well maintained by the source.
* The Number of data usages from the source.
* The data in the source is Upto Date.
* Examples:
* ISO stndards
* CIA world factbook
* Maxmind
* Google's libPhoneNumber library



## Contribution Flow:
![contributionFlow.png](media/contributionFlow.png)

### Contribution Guidelines:

1) **Source Reliability:**
* Make sure that the source that you're referring is reliable, based on the factors mentioned in the Source Reliability section.
2) **Versioning Policy:**
* Before making a new version, please go through this [versioning policy](versioning-policy.md) guidelines.
2) **Description File:**
* Add a Description file in the format specified, so that we have all the information needed for review
* Make sure the `Description.md` file contains the following mandatory fields
* Source of the Data
* Author
* Relavent descriptions for the Fields in Data
* Version based on the [versioning policy](versioning-policy.md)
3) **Schema Updates:**
* When adding a new field to the schema and making it required, add the field name to the array containing all required fields in `scheme.json`.
4) **Data and Schema Validation:**
* Please, ensure that the data in the newer version aligns with the schema of the corresponding version.
* We run the validation check in the form of github actions to cross the data file with the schema file.
5) **Addition/Deleting in data/country-zipcode folder**
* When trying to Add a new Country Zipcode data (or) Delete an existing Country zipcode data, Make sure you modify the `available_countries` array in the `data/scripts/dataValidate.ts` file, to run the validation script
* Eg:
* If you Add a new country Afghanistan Data, modify
* `const available_countries = ['IN', 'US', 'MY', 'SG'];` to `const available_countries = ['IN', 'US', 'MY', 'SG','AF'];`
* If you Delete an existing country Singapore Data, modify
* `const available_countries = ['IN', 'US', 'MY', 'SG'];` to `const available_countries = ['IN', 'US', 'MY'];`

Please adhere to these guidelines to maintain consistency and integrity within the repository. Your contributions are greatly appreciated!
8 changes: 8 additions & 0 deletions data/country-zipcode/Description.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
| Title | --- |
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Version | 1.0.0 |
| Description | Adding India, Malaysia, Singapore & United States Zipcode level Data |
| Author | [Chaitanya-019](https://github.com/Chaitanya-019) |
| Source | GeoNames |
| Attributes | country_name : Name of the Country <br><br> states : List of states in the Country <br><br> states/name : Name of teh state <br><br> cities : List of cities in teh State <br><br> states/cities/name : Name of the City <br><br> states/cities/timezone : Timezone of the city. <br><br> states/cities/zipcodes : List of available zipcodes in teh city <br><br> states/cities/region_name/district_name : District in which the city is situated |
| miscellaneous | size: 6 mb | |

0 comments on commit 51178e7

Please sign in to comment.