Skip to content

Conversation

@Welding-Torch
Copy link

Description:

This pull request proposes the addition of a devcontainer.json file to streamline and standardize the development environment setup using Visual Studio Code's Remote - Containers extension.

Changes Proposed:

  • Added a .devcontainer directory to the project root.
  • Created a devcontainer.json file within the .devcontainer directory to define the development environment configuration.
  • Configured the devcontainer.json file to install necessary tools and dependencies during container creation and startup.
  • Added a postCreateCommand.sh file within the .devcontainer directory to define post creation commands.
  • Documented the setup process and requirements in the project's README.

Why is this Change Needed?

A devcontainer.json file brings several advantages:

  • Consistency: It standardizes the development environment, reducing configuration discrepancies among team members.
  • Onboarding: It simplifies onboarding for new contributors, ensuring they have a consistent development environment.
  • Isolation: It isolates project dependencies and tools, preventing conflicts with the developer's local environment.
  • Automation: It facilitates automated testing and continuous integration.

Testing:

  • Not tested, due to lack of time.

Related Issue:
#184

@SirusCodes SirusCodes requested a review from a team September 16, 2023 19:39
@KartikSoneji
Copy link
Member

Can we use the same docker image as the actions (docker://asciidoctor/docker-asciidoctor:latest) for consistency?

@Welding-Torch
Copy link
Author

Requesting an update on this.

@SirusCodes
Copy link
Member

Requesting an update on this.

There are no updates 🙃

Remind me to do this in catchup

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.

3 participants