dash icon indicating copy to clipboard operation
dash copied to clipboard

refactor: move all requires-* to common folder

Open Borda opened this issue 9 months ago • 2 comments

This is just a suggestion, and fell free to reject it fro any reason, but I believe this would make the project navigation easier as all requirements files will we grouped in a single folder and not pealing in the root :flamingo:

Contributor Checklist

  • [ ] I have broken down my PR scope into the following TODO tasks
    • [ ] task 1
    • [ ] task 2
  • [x] I have run the tests locally and they passed. (refer to testing section in contributing)
  • ~I have added tests, or extended existing tests, to cover any new features or bugs fixed in this PR~

optionals

  • [ ] I have added entry in the CHANGELOG.md
  • [ ] If this PR needs a follow-up in dash docs, community thread, I have mentioned the relevant URLS as follows
    • [ ] this GitHub #PR number updates the dash docs
    • [ ] here is the show and tell thread in Plotly Dash community

Borda avatar Apr 30 '24 13:04 Borda

Sorry it took a long time to review, I couldn't decide if I like this change or not.

On one hand I like to have them easily accessible at the root for ease of use and that way our dependencies are right on the github front page for everyone to see.

But putting them in a subfolder is actually a bit better for completion on the shell and the root is kinda crowded making the requirements files requires scrolling to get to them.

I would just rename the requires folder to requirements to be more like the standard requirements.txt of Python projects then I think we are good with this change.

cc @ndrezn @gvwilson

T4rk1n avatar May 28 '24 13:05 T4rk1n

thanks @T4rk1n - @Borda, are you OK making the suggested change and pushing again?

gvwilson avatar May 28 '24 13:05 gvwilson

I couldn't decide if I like this change or not.

that is completely fine :)

I would just rename the requires folder to requirements to be more like the standard requirements.txt of Python projects then I think we are good with this change.

sure, will make it... with requires I tried to be closer to the actual case but tbh, but requirements would be my first/natural choice :)

Borda avatar May 30 '24 10:05 Borda