From bcd375a41c1a1f6fb1af8f6099634ff7ed1ffbdd Mon Sep 17 00:00:00 2001 From: emisargent <55098699+emisargent@users.noreply.github.com> Date: Fri, 10 Feb 2023 23:21:22 +0000 Subject: [PATCH] Update CHANGES and CONTRIBUTING --- CHANGES.rst | 2 ++ CONTRIBUTING.rst | 26 ++++++++++++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 94c16a34..aaa2964c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -6,6 +6,8 @@ Unreleased - Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``. :pr:`4947` - Ensure subdomains are applied with nested blueprints. :issue:`4834` +- Automatically setup project and install dependencies with the + ``.devcontainer/devcontainer.json``. :issue:`4965` Version 2.2.3 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8962490f..d458e2fb 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -67,8 +67,27 @@ Include the following in your patch: .. _pre-commit: https://pre-commit.com -First time setup -~~~~~~~~~~~~~~~~ +First time setup using GitHub Codespaces +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`GitHub Codespaces`_ allow you to create an instant and dedicated +development environment. Codespaces open by default in Visual Studio +Code for the web. Codespaces created from Flask are configured with +a `devcontainer`_ that installs required dependencies for you. + +- Make sure you have a `GitHub account`_. +- Fork Flask to your GitHub account by clicking the `Fork`_ button. +- From your fork's repository page, click the green "Code" button and + then "Create codespace on main" +- Wait for the codespace to load and the "postAttachCommand" to + finish running. +- Checkout a new branch and :ref:`start coding` + +.. _GitHub Codespaces: https://docs.github.com/en/codespaces +.. _devcontainer: https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers + +First time setup in your local environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Download and install the `latest version of git`_. - Configure git with your `username`_ and `email`_. @@ -201,6 +220,9 @@ Generating a report of lines that do not have test coverage can indicate where to start contributing. Run ``pytest`` using ``coverage`` and generate a report. +If you are using GitHub Codespaces, ``coverage`` is already installed +so you can skip the installation command. + .. code-block:: text $ pip install coverage