Skip to content
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

Jump to bottom

README improvements #1

Open
rufuspollock opened this issue Mar 31, 2016 · 0 comments
Open

README improvements #1

rufuspollock opened this issue Mar 31, 2016 · 0 comments

Comments

@rufuspollock
Copy link
Member

A. Description at top of README should be more extensive. You want an entire paragraph here and a good opening sentence. Key things to cover:

  • What this is: Time series data of major commodity prices (maybe give some examples)
  • Where it comes from: IMF

See other data packages for examples.

B. Markdown in source section is wrong. BTW in general i would not have this in the README but leave the home page in the datapackage sources and the specific excel link in the code.

C. Do not have Description subheading of data (there is no need)

D. I would make "indexes" and "Commodity Prices" (note your typo) into actual mini-headings or plain bold to avoid double indention of list.
@rufuspollock rufuspollock changed the title Description at top of README should be more extensive README improvements Mar 31, 2016
anuveyatsu pushed a commit that referenced this issue Sep 18, 2023
@gradedSystem
GH Actions to update the dataset (#5)
9e43339 
* Create update.yml

* Update update.yml

* Update update.yml

* Update update.yml

* Update update.yml

* Change cron schedule time

* [ex][s] fixed github CI/CD - #1
anuveyatsu pushed a commit that referenced this issue Sep 20, 2023
@gradedSystem @actions-user
Creating pull requests for the commodity-prices (#6)
3c53eca 
* Create update.yml

* Update update.yml

* Update update.yml

* Update update.yml

* Update update.yml

* Change cron schedule time

* [ex][s] fixed github CI/CD - #1

* [ex][s] add requirements & fixed workflow - #2

* [ex][s] added workflow dispatch for manual trigger - 3

* [ex][s] added workflow dispatch for manual trigger - 4

* [ex][m] small changes in process.py - 5

* [ex][m] small changes in process.py - 6

* [ex][m] update requirements - 7

* [ex][s] update yaml with github token - 8

* Auto-update of the data package

* [ex][m] added update data - 9

* Auto-update of the data package

---------

Co-authored-by: GitHub Action <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rufuspollock