Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 1.61 KB

Contributing to Bloom

Initial setup of project Bloom for development

Installation

  1. Create a virtual environment for python dependencies. Use following command in terminal.

    python -m venv venv

  2. To activate or re-activate the environment, run the following command.

    • in Linux / MacOS / git console:

      source venv/Scripts/activate

    • in Windows cmd.exe:

      venv\Scripts\activate.bat

    • in Windows PowerShell:

      venv\Scripts\Activate.ps1

    (Note that you need to use python, not python3 to run your scripts.)

  3. Install all dependencies including dev dependencies specified in pyproject.toml. Using '-e' flag makes the project editable and easy to modify.

    pip install -e .[dev]

  4. Install pre-commit to the directory.

    pre-commit install

After these steps, code formatting and other hooks defined in .pre-commit-config.yaml should run locally before each commit on modified files. This will modifiy staged files and you might need to restage them again for commit if any issues are fixed.

Add Submodule

In order to initialize team A's repository as submodule, run the following commands in the root directory of the project:

git submodule init

git submodule update

The submodule is specified in .gitmodules.

How to use installed package

With editable package structure, you can import the package to anywhere you want as shown below.

import bloom