Skip to content

chore: configure gitpod #11

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

Merged
merged 3 commits into from
Nov 8, 2023
Merged

Conversation

vil02
Copy link
Member

@vil02 vil02 commented Nov 7, 2023

This PR allows to use this repository in gitpod.

In the created environment, it is possible to successfully run the commands

busted -o utfTerminal .spec

and

luacheck .

Besides the fact that several repositories in TheAlgorithms are ready to use in gitpod, I think it is a good idea to have it, since it shows the newcomers how to create their own development environment.

@vil02 vil02 marked this pull request as ready for review November 7, 2023 18:35
@Panquesito7 Panquesito7 added the enhancement New feature or request label Nov 7, 2023
Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Thanks! 🚀

@Panquesito7 Panquesito7 requested a review from appgurueu November 7, 2023 20:10
Copy link
Collaborator

@appgurueu appgurueu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Frankly, I'm not much of a fan of Gitpod; I don't really see the benefits.

All this does for a newcomer is set up a crippled Ubuntu image with Lua, Luarocks, Luacheck and Busted installed in a "cloud development environment". To actually commit their changes, users would further need to grant wide-reaching permissions to Gitpod. I don't think this is how newcomers should approach this, depending on Gitpod just to save them 5 minutes of setting up the dependencies.

Ultimately, programmers - and this includes newcomers to this repo - need to be able to set up a dev environment. Given the few and simple "dependencies" of this repo, I see no need to involve Docker - over a 3rd-party service, no less - yet; again, I don't think we should lead newcomers to use Gitpod.

(And even if Gitpod were to lower the barrier to entry, that won't necessarily be a good thing; I doubt that someone who would have been unable to set up a dev environment is able to make a substantial contribution.)


That said, to "show the newcomers how to create their own development environment", we should probably add a "getting started" section to the Readme - adding some links to the Lua / Luarocks / Luacheck / Busted installation / getting started pages, perhaps even a few ready-to-go commands and instructions for the most popular operating systems for convenience.

Newcomers will have to deal with dev env setup either way; neither Luacheck nor Busted invoke themselves, and for Luacheck I highly recommend editor support; it doesn't even seem possible to install a Luacheck extension on Gitpod out of the box:

Screenshot from local VSC:
Screenshot from 2023-11-08 13-43-40
Screenshot from Gitpod:
Screenshot from 2023-11-08 13-43-08

(perhaps this is fixable?)


If Gitpod support were accepted, this PR would also be missing a mention of Gitpod in the Readme.

@vil02
Copy link
Member Author

vil02 commented Nov 8, 2023

@appgurueu I think that the cost of maintaining gitpod setup is minimal. The benefits are that (gitpod users) can contribute from a browser. If I would not find it useful, I would not create this PR.

@vil02 vil02 requested a review from appgurueu November 8, 2023 16:37
Copy link
Collaborator

@appgurueu appgurueu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not strongly opposed to this; it is true that the maintenance cost is limited, though I think users would probably be best advised to avoid Gitpod (but at the end of the day, they are still free to choose).

@appgurueu appgurueu merged commit 7136332 into TheAlgorithms:main Nov 8, 2023
@appgurueu
Copy link
Collaborator

Thanks for the PR!

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

Successfully merging this pull request may close these issues.

3 participants