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

Add a .devcontainer #1571

Merged
merged 3 commits into from
Jan 17, 2024
Merged

Add a .devcontainer #1571

merged 3 commits into from
Jan 17, 2024

Conversation

MichaelChirico
Copy link
Contributor

This allows users to develop roxygen2 directly from the browser with GitHub Codespaces.

One nice side effect is encapsulating (in the Dockerfile) the minimal setup needed to get roxygen2 prepared for development locally.

Config/Needs/development is a way to strike a balance between installing all of Imports+Suggests (takes longer to build the container) and missing some pieces essential to development (testthat's a good example -- you can't really do most dev work without running the test suite --> need testthat).

In {lintr}, we also added {pkgload} here since that is used a lot in dev workflow. ({roxygen2} already Imports {pkgload}, of course):

https://github.com/r-lib/lintr/blob/bad1632f23b77f41cec13fb6f1c883302f64f506/DESCRIPTION#L55

@hadley hadley merged commit ca70262 into r-lib:main Jan 17, 2024
12 checks passed
@hadley
Copy link
Member

hadley commented Jan 17, 2024

Happy to include with the caveat that we won't maintain it, so if any problems crop up with it I'll be cc'ing you 😄

@MichaelChirico MichaelChirico deleted the devc branch January 18, 2024 02:12
@MichaelChirico
Copy link
Contributor Author

makes sense+SGTM! hopefully it's of use to some others :)

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