docs: add testing guidelines and create CONTRIBUTING.md #687
Conversation
Document standardized check commands in README for local development. This provides a simple interim solution for running quality checks that match CI, without introducing additional dependencies. Closes #685
There was a problem hiding this comment.
Looks good. Let's move all the contributing docs into a separate file similar to https://github.com/vega/vega/blob/main/CONTRIBUTING.md.
|
Thanks for the feedback @domoritz! I agree that moving the detailed contributing info to a separate CONTRIBUTING.md would be better, following Vega's main repo structure. I also think altair's contributing guidelines are a great model of clarity. I've converted this to a draft PR. I'll update it to:
Does that approach sound good? |
dsmedia
changed the title
|
Excellent |
- adds link to CONTRIBUTING.md (forthcoming)
|
@dangotbanned I'm updating the readme and would like to concisely capture the distinctions between the canonical datasets, the Altair-adapted version, and the older PyPI package, as well as a bit on the work you're doing to integrate all of this. Would welcome any input! |
|
|
||
| To make a release, run `npm run release`. | ||
| Vega Datasets is maintained by the UW Interactive Data Lab along with a community of contributors. Appreciation is extended to the numerous organizations and individuals who have generously shared their data for use in this collection. |
There was a problem hiding this comment.
@domoritz Please feel free to make any necessary modifications here if you'd like.
|
|
||
| Here is a full example | ||
| - **JavaScript/Observable**: Directly import Vega Datasets in Observable. See the [example notebook](https://observablehq.com/@vega/vega-datasets). | ||
| - **Python**: Access datasets using the [Vega Datasets Python package](https://github.com/altair-viz/vega_datasets). |
There was a problem hiding this comment.
@dangotbanned please feel free to modify if you'd like to reference the ongoing work here (and perhaps to note that at present there is not full overlap?)
Document standardized check commands in
READMEa newCONTRIBUTING.mdfor local development. This provides a simple interim solution (ahead of astral-sh/uv#5903) for running quality checks that match CI, without introducing additional dependencies. Also adds a minimal development section to README.md that points to the new contributing guidelines. This will focus on technical contribution guidelines.To do
Closes #685