From a3cb31c5010d035314245b27f450db3437d921c7 Mon Sep 17 00:00:00 2001 From: Ari Chivukula Date: Fri, 13 Dec 2024 10:10:58 -0500 Subject: [PATCH] Codespaces config (#702) --- .devcontainer/devcontainer.json | 16 ++++++++++++++++ .github/dependabot.yml | 12 ++++++++---- CONTRIBUTING.md | 2 ++ 3 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000..4b2eb501 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,16 @@ +{ + "name": "Default", + "image": "mcr.microsoft.com/devcontainers/python:3.13", + "features": { + "ghcr.io/devcontainers-extra/features/black:latest": {} + }, + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "github.vscode-github-actions" + ] + } + }, + "postCreateCommand": "pip3 install -r requirements.txt" +} diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ed58bff3..5817a4fb 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,7 +5,11 @@ version: 2 updates: - - package-ecosystem: "pip" - directory: "/" - schedule: - interval: "daily" +- package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" +- package-ecosystem: "devcontainers" + directory: "/" + schedule: + interval: "daily" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cfc69e7..754aade9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,3 +33,5 @@ use GitHub pull requests for this purpose. Consult information on using pull requests. Any modified python code must conform to the standards of [black](https://github.com/psf/black). + +Contributors, especially those modifying more than just `related_website_sets.JSON`, are encouraged to use [Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces) as all the packages you need will be set up for you.