-
Notifications
You must be signed in to change notification settings - Fork 242
Home
Xiaming edited this page Mar 26, 2019
·
4 revisions
Welcome to visit Awesome Public Datasets.
It is simple to contribute to APD:
-
Fork
apd-core
repository into your own namespace such asyourname/apd-core
. -
Clone your project locally:
git clone https://github.com/yourname/apd-core.git
cd apd-core
- 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
- Run local test to validate your modification:
# With python
sudo pip install -r tests/requirements.txt
./tests/testing.sh
- 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
- Create a new Pull Request to the trunk repository on Github page, usually
https://github.com/yourname/apd-core/pulls