-
Notifications
You must be signed in to change notification settings - Fork 83
Closed
Labels
contributionThank you to the contributor!Thank you to the contributor!dockerimplementedimplemented tag means that either an enhancement or feature request has been implemented, or bugfiximplemented tag means that either an enhancement or feature request has been implemented, or bugfix
Description
Summary
The project might benefit from providing Github's Codespaces or vscode's devcontainers configurations to allow contributors to use a Docker-based dev environment. I have a branch with a draft version, but it would require some polishing and considerations; see https://github.com/hsloot/latexindent.pl/tree/add-devcontainer. In my view, the main benefit would be that it makes it easy for inexperienced contributors (latex users but are inexperienced with Perl) to test small changes before creating PRs or debug their code when PR checks fail.
Considerations
- Align the devcontainer image with the already existing Docker image created for using latexindent?
- Align with the test workflow for pull requests such that the test workflow passes if the tests run successfully in a new devcontainer instance?
TODOs
- Provide documentation.
- Improve documentation about building and testing.
- Adjust Dockerfile to already install all required Perl modules.
Metadata
Metadata
Assignees
Labels
contributionThank you to the contributor!Thank you to the contributor!dockerimplementedimplemented tag means that either an enhancement or feature request has been implemented, or bugfiximplemented tag means that either an enhancement or feature request has been implemented, or bugfix