datopian / datopian/ckanext-datastore-bigquery
Improve Docs + setup CI tests
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Improve Docs + setup CI tests.
- I expect to see a README update documenting this for:
- users (i.e. those using the API)
- admins installing this (e.g. can i configure the point at which i switch from streaming to bulk export)
- some info for developers on design approach
- I'd expect a test of the lower level functionality like extracting a big query query to a file in gcs (do we have that? if not let's add something for that helper method).
- Do we CI tests? if so can we get badge into the README.
Originally posted by @rufuspollock in https://github.com/datopian/ckanext-datastore-bigquery/pull/2#issuecomment-672746559
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README and locating the lower-level helper for extracting a BigQuery query to a file in GCS, then inspect whether CI tests already exist. Done means the README covers users, admins, and developers, the helper has a test, and the README includes a CI badge.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- google-cloud, python
- Domain
- ci-cd, data, documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100