MACH-Aero icon indicating copy to clipboard operation
MACH-Aero copied to clipboard

Added devcontainer for quick setup in vscode

Open akshatd opened this issue 1 year ago • 0 comments

Purpose

Add a devcontainer to the repo so that it is easier for users to set this up in a single click

Expected time until merged

Not urgent, can be merged whenever the maintainers feel the need for it

Type of change

This is more of a devops change, gonna mark it as Maintenance

  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (non-backwards-compatible fix or feature)
  • [ ] Code style update (formatting, renaming)
  • [ ] Refactoring (no functional changes, no API changes)
  • [ ] Documentation update
  • [x] Maintenance update
  • [ ] Other (please describe)

Testing

  • Install (all steps are here)
    • vscode
    • docker
    • devcontainer extension
  • Open the repository in vscode
  • click open in devcontainer
  • go through the tutorial

Checklist

  • [x] I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • [x] I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • [x] I have run unit and regression tests which pass locally with my changes
  • [x] I have added new tests that prove my fix is effective or that my feature works
  • [x] I have added necessary documentation

akshatd avatar Dec 07 '23 02:12 akshatd