Home

Welcome to visit Awesome Public Datasets.

How to contribute new data entry

It is simple to contribute to APD:

1. Fork apd-core repository into your own namespace such as yourname/apd-core.

2. Clone your project locally:

git clone https://github.com/yourname/apd-core.git
cd apd-core

3. Create a new data entry from template PULL_REQUEST_TEMPLATE.yml.

For example, we want create NEW_DATASET.yml under category folder of Government:

cp PULL_REQUEST_TEMPLATE.yml ./core/Government/NEW_DATASET.yml

Then edit data fields as you want:

vim ./core/Government/NEW_DATASET.yml 

For data validation, it requires three essential data fields: title, homepage and category, while the category should be the same with the folder name, i.e., "Government" in the example.

In a nutshell, you should get a basic entry like

---
title: New Dataset Name
homepage: https://example.com
category: Government

4. Run local test to validate your modification:

# With python
sudo pip install -r tests/requirements.txt
./tests/testing.sh

5. Commit local modifications to your repository:

git add ./core/Government/NEW_DATASET.yml
git commit -m "Add NEW_DATASET under government"  # Any message as you want
git push origin master

6. Create a new Pull Request to the trunk repository on Github page, usually https://github.com/yourname/apd-core/pulls