Skip to content

Comments

Enable devcontainer for remote development on GitHub#63

Merged
DavidTorresIPA merged 9 commits intomainfrom
feature/setup-devcontainer
May 28, 2025
Merged

Enable devcontainer for remote development on GitHub#63
DavidTorresIPA merged 9 commits intomainfrom
feature/setup-devcontainer

Conversation

@NKeleher
Copy link
Contributor

@NKeleher NKeleher commented May 22, 2025

Pull Request Summary 🚀

What does this PR do? 📝

Creates the ability to use Codespaces on GitHub.

Why is this change needed? 🤔

We want to enable IPA staff to quickly get set up and contribute to the Knowledge Hub without having to install software on their laptops.

How was this implemented? 🛠️

Create a .devcontainer/ set up with Docker and a .devcontainer/.devcontainer.json that includes Quarto, R, and Python environments such that a user can modify and build the website within a Codespace on GitHub.

❗ I had to disable the research-design/sample-size-power.qmd because that is dependent on Stata to execute code. If using codespaces, any Stata code will not execute. will need to run locally with your Stata installation for the time being.

References for future consideration if we want to include Stata in the Codespace:
https://github.com/AEADataEditor/stata-project-with-docker
https://github.com/AEADataEditor/docker-stata

How to test or reproduce? 🧪

Go to this PR's branch: https://github.com/PovertyAction/ipa-research-data-science-hub/tree/feature/setup-devcontainer

And, on the green "Code" button, select Codespaces >> + to add a codespace.

Once the codespace is built (this may take some time ~10 mins), you should be able to open your codespace from the browser or open in VS Code.

Screenshots (if applicable) 📷

image image

Checklist ✅

  • I have run and tested my changes locally
  • I have limited this PR to less than 1000 lines of code change (if not, explain why)
  • I have run linting and formatting on any code changes (if applicable)
  • I have updated the documentation (README, etc.) accordingly
  • I have reviewed and resolved any merge conflicts
  • I have reviewed and resolved any Vale errors

Reviewer Emoji Legend

:code: Meaning
😃👍💯 :smiley: :+1: :100: I like this...

...and I want the author to know it! This is a way to highlight positive parts of a code review.
⭐⭐⭐ :star: :star: :star: Important to fix before PR can be approved...

And I am providing reasons why it needs to be addressed as well as suggested improvements.
⭐⭐ :star: :star: Important to fix but non-blocking for PR approval...

And I am providing suggestions where it could be improved either in this PR or later.
:star: Give this some thought but non-blocking for PR approval...

...and consider this a suggestion, not a requirement.
:question: I have a question.

This should be a fully formed question with sufficient information and context that requires a response.
📝 :memo: This is an explanatory note, fun fact, or relevant commentary that does not require any action.
:pick: This is a nitpick.

This does not require any changes and is often better left unsaid. This may include stylistic, formatting, or organization suggestions and should likely be prevented/enforced by linting if they really matter
♻️ :recycle: Suggestion for refactoring.

Should include enough context to be actionable and not be considered a nitpick.

@NKeleher NKeleher marked this pull request as ready for review May 22, 2025 21:26
@NKeleher NKeleher requested a review from a team as a code owner May 22, 2025 21:26
@NKeleher NKeleher changed the title [WIP] Enable devcontainer for remote development on GitHub Enable devcontainer for remote development on GitHub May 22, 2025
@DavidTorresIPA DavidTorresIPA merged commit 6f90ec4 into main May 28, 2025
4 checks passed
@DavidTorresIPA DavidTorresIPA deleted the feature/setup-devcontainer branch May 28, 2025 18:15
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.

2 participants