Update the readme

Question

Update the readme

Closed this issue 3 years ago · 4 comments

jhorbowicz commented 3 years ago

We have only the basic readme. It is not helpful at all for people who would potentially like to contribute.

Answer 1 · 2021-10-29T08:51:44.000Z

Can we consider rolling the backend and frontend into one git repo? Is there any value added by keeping them apart?

Answer 2 · 2021-10-31T11:16:32.000Z

I've proposed a MR for this.

Answer 3 · 2021-11-01T19:49:44.000Z

Can we consider rolling the backend and frontend into one git repo? Is there any value added by keeping them apart?

Could you elaborate on that? What problems would it solve? I don't see any, to be honest. Those are completely independent apps, that are written in different stacks and by different people. Unless there are some really good arguments for that, or others have different opinion on that, I would avoid keeping it in one repository.

Answer 4 · 2021-11-01T23:57:57.000Z

From my POV, keeping them separate only makes sense, if there are more consumers. So not only this frontend.

It would improve:

Dev Setup (essentially makes the readme shorter)
History (ideally you'll implement frontend and backend in tandem in the same PR/commits)
Confusion on which backend is the correct one this frontend uses
And also makes it more natural, to open this in one editor (but you could have done that before)

To make it clear, those are NOT really good arguments in my book, but if dev experience matters, it might be worthwhile.