Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.32 KB
Raw

Issue Flow

Hi! We're so glad you are interested in contributing to this project. We track all of our issues on the GitHub Issues Page.

If you report an issue, please be descriptive and include details on how to redproduce the bug. Then, a developer will get to work on the bug, or you can do so by going to Development section below to take a look on how to work on Tuna!

Development

Hi! Let's get started with development:

Getting Started

IMPORTANT: Unless you are an authorized developer, never use the ./build.sh script. All pull requests that edit the dist directory in this way will be rejected.

Dependency Prerequisites:

  • python3.12+
  • git

Do the following

git clone https://github.com/abhi-arya1/tuna.git
# and
cd tuna
# and
python3 -m venv venv
# and
source venv/bin/activate # for MacOS
. venv/bin/activate # for Linux
# and
pip install -r "requirements.txt"
# and
pip install -e .

to begin pip development mode.

Tuna relies on minimalistic external packages to keep the installation lightweight, and most of our functionality is done directly through standard library functions.

Making a Change

Now, what you can do is begin on your change. Once done, fork the repository, make a Pull Request, and we'll approve it ASAP!