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

Improve Local Dev Setup Documentation and Contribution Guidelines #339

Merged
merged 3 commits into from
Feb 6, 2024

Conversation

zachgoll
Copy link
Collaborator

@zachgoll zachgoll commented Feb 6, 2024

We've had several local setup issues and self-hosting questions:

The goal of this PR is to consolidate all of these into one spot.

I've updated the README and CONTRIBUTING guide alongside some additional setup guides in the Wiki:

These guides are a WIP and will be centralized places for us to communicate the best way to get started for local development and self-hosting.

@cartwatson
Copy link

As someone currently trying to get this setup for dev this looks useful to me. Only thing that stood out was line 38 of the README, it gets rid of the shell syntax highlighting, admittedly not that useful but better to have it imo.

@robzolkos
Copy link
Contributor

robzolkos commented Feb 6, 2024

This is amazingly well done 👏🏻

Notice in the individual setup guides in the wiki it mentions setting up Node - however - so far - the codebase doesn't need it (using importmaps instead), so perhaps some setup complexity that could be removed from the wiki?

@zachgoll
Copy link
Collaborator Author

zachgoll commented Feb 6, 2024

@robzolkos good point, will remove those for now!

@leemcalilly
Copy link
Contributor

Should using Docker with the dev container be included or are y'all thinking about moving away from that?

@zachgoll
Copy link
Collaborator Author

zachgoll commented Feb 6, 2024

@leemcalilly are you referring to adding a dedicated guide for developing locally with Dev Containers?

@robzolkos may have to jump in on that one—I'm not using the Dev Container myself but I've seen a few questions surrounding it.

@zachgoll zachgoll merged commit ae241c2 into main Feb 6, 2024
4 checks passed
@zachgoll zachgoll deleted the add-local-dev-setup-guides branch February 12, 2024 14:56
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

Successfully merging this pull request may close these issues.

4 participants