orbit-oss/flask
4
5
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update CHANGES and CONTRIBUTING

Browse source
This commit is contained in:
emisargent 2023-02-10 23:21:22 +00:00
parent 3907da8bfe
commit bcd375a41c
2 changed files with 26 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGES.rst
View file

@ -6,6 +6,8 @@ Unreleased
- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``. - Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.
:pr:`4947` :pr:`4947`
- Ensure subdomains are applied with nested blueprints. :issue:`4834` - 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 Version 2.2.3

26
CONTRIBUTING.rst
View file

@ -67,8 +67,27 @@ Include the following in your patch:
.. _pre-commit: https://pre-commit.com .. _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<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`_. - Download and install the `latest version of git`_.
- Configure git with your `username`_ and `email`_. - 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 where to start contributing. Run ``pytest`` using ``coverage`` and
generate a report. generate a report.
If you are using GitHub Codespaces, ``coverage`` is already installed
so you can skip the installation command.
.. code-block:: text .. code-block:: text
$ pip install coverage $ pip install coverage