Improve new contributor onboarding experience

clausherther / nfl-dbt

This repo contains dbt models to transform NFL Play-by-Play (pbp) data sourced from https://github.com/nflverse/nflverse-data into analytical models

Apache License 2.0

20 stars 4 forks source link

Improve new contributor onboarding experience #7

Open bbrewington opened 1 year ago

bbrewington commented 1 year ago

Saving some notes/questions here as I'm reviewing contents of the repo. Might be good to include a brief "how this project is set up" guide somewhere, and glad to help build it myself & submit PR

Add instructions for getting started (inspired by hoodie README)

[ ] Add Setup section to README
[ ] Add Usage section to README
[ ] Add Testing section to README

Other questions

[x] How to use .vscode/.ropeproject?
[x] How to generalize .vscode/settings.json for any user? (currently has /Users/claus as base for pythonPath)

clausherther commented 1 year ago

hi @bbrewington, thanks for this issue! I'm not really actively maintaining this repo anymore, since there too many other competing work and open source projects. However, happy to look at any PRs! Re: your other questions, those .vscode files probably shouldn't have been checked in as they're not material to this project.

bbrewington commented 1 year ago

@clausherther cool, thanks for deleting that folder! would you mind giving me write access to the repo? I'm glad to take it on as a maintainer. Been working on some sports analytics stuff, and have R experience so definitely in my wheelhouse to get it up to speed

clausherther commented 1 year ago

Great, thanks! Just invited you.