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

Adds Dev Container Configuration #105

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cr2007
Copy link

@cr2007 cr2007 commented Jul 6, 2024

Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.

What is the motivation?

Makes it easier to start contributing to the project. The steps for setting up the development environment are not mentioned in CONTRIBUTING.md as mentioned in #95 , so I thought it would be much easier to add this setup as well.

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

What does this change do?

This makes it a lot easier to jump straight into development, along with clearly defined port forwarding for running any tests.

What is your testing strategy?

Is this related to any issues?

Fixes #95

Have you read the Contributing Guidelines?

- Add `.devcontainer/devcontainer.json` with container configuration
- Add `.devcontainer/setup.sh` for initial setup commands
- Add `.devcontainer/welcome.txt` for user welcome message
- Remove commented Dockerfile build section in `devcontainer.json`
- Add `codespaces` customization to open `README.md` on start
- Minor formatting adjustments in `devcontainer.json`
@cr2007 cr2007 changed the title Docs 95 devcontainer setup Adds Dev Container Configuration (#95) Jul 6, 2024
@cr2007 cr2007 changed the title Adds Dev Container Configuration (#95) Adds Dev Container Configuration Jul 6, 2024
@cr2007
Copy link
Author

cr2007 commented Jul 6, 2024

You can view the changes yourself in the codespace by clicking on the Code button on the top-right.

image

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.

Documentation: CONTRIBUTING.md should include dev setup
1 participant