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.

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

Add contributing.md #2

Open
itepifanio opened this issue Dec 7, 2023 · 2 comments
Open

Add contributing.md #2

itepifanio opened this issue Dec 7, 2023 · 2 comments

Comments

@itepifanio
Copy link

itepifanio commented Dec 7, 2023

Hi, great repo idea! I recently gave a talk about data apps with python and this repository would be an excellent example to showcase in that context.

Do you mind adding a contributing.md? I'm not sure how you're installing the dependencies and how the tests are running.

@gshotwell
Copy link
Collaborator

What were you thinking should be in that document? The repo doesn't have any tests or build process so it might be better to just include that information in the README

@itepifanio
Copy link
Author

What were you thinking should be in that document?

Some guidelines about how to install the deps, how to add a new app into a problem. For example, at sampling-dashboard we have a requirements.txt for all the packages and no individual README.md but at file-monitoring it has its own requirements.txt and README.md, it's not clear how newcomer's code should be structured.

Data it's repeating itself too (nyc-taxi.csv for example), it's a good practice? This kind of explanation would be welcome at the contributing guidelines.

might be better to just include that information in the README

Sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants