Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

100 lines (75 loc) · 3.08 KB

CONTRIBUTING

Welcome to the contributing guidelines for Biscuit. This document will help you get started with contributing to Biscuit.

Setting up Environment

Note

Python 3.11 or above is required for building Biscuit.

Fork the Biscuit repository and clone locally.

$ git clone https://github.com/tomlin7/biscuit.git
$ cd biscuit

Make a virtual environment to prevent dependency conflicts.

$ python -m venv .venv
$ source ./.venv/bin/activate

Important

Linux distribtions require some system packages to be installed prior to the poetry installation.

For Debian based distributions,

$ sudo apt install fontconfig libfontconfig1 libfontconfig1-dev cmake cmake-data extra-cmake-modules build-essential
$ python -m pip install scikit-build

For Arch Linux based distributions,

$ sudo pacman -Sy
$ sudo pacman -S base-devel cmake extra-cmake-modules fontconfig tcl tk
$ python -m pip install scikit-build
$ python -m pip install tkextrafont

In the root directory, run poetry install. Try to launch biscuit from source with simply biscuit (or poetry run biscuit) and make sure everything looks good.

Project Structure

The codebase of Biscuit is divided into 3 main parts:

  • /biscuit: Main codebase of the App.
  • /tests: unit tests for Biscuit (WIP).
  • /docs: documentation for Biscuit (WIP).

Please make sure to follow the PEP8 style guide.

/biscuit

  • /config: configuration files for the app (WIP).
  • /core: the core codebase of the app.
  • /extensions: extensions directory.
  • /res: icon fonts, bitmaps, images, etc.

Main interest here is in the /core directory.

  • /core/components: all components of app such as editors, git, extension manager, views and floating views such as menu, notifications and palette, etc.
  • /core/layout: the GUI structure, statusbar, menubar, editor-view-terminal managers, etc.
  • /core/utils: keyboard shortcuts, events manager, etc.
  • /core/settings: preferences, configuration manager, settings editor, themes, etc.

The App class

Main point of having this class is to have a single point of access to all the important parts of the app.

Important

This class holds reference to all the components of Biscuit and every class of biscuit have a reference to this base class

  • Example: Accessing the active editor instance from Foo class of biscuit:

    class Foo:
    ...
    def foo(self):
        editor = self.base.editorsmanager.active_editor
        if (editor.content and editor.content.exists):
            print(editor.path)
            if (editor.content.editable):
                self.base.notifications.info(":)")

  • Example: Accessing the menubar from Foo class of biscuit:

    class Foo:
    ...
    def foo(self):
        filemenu = self.base.menubar.file_menu
        filemenu.add_item("this", lambda: print("Wah"))

        xyzmenu = self.base.menubar.add_menu("Wah")
        xyzmenu.add_item("stuff", lambda: print("Wah"))