Skip to content

Latest commit

 

History

History
188 lines (126 loc) · 12.8 KB

CONTRIBUTING.md

File metadata and controls

188 lines (126 loc) · 12.8 KB
Raw

Contributing to TagStudio

Last Updated: December 12th, 2024

Thank you so much for showing interest in contributing to TagStudio! Here are a set of instructions and guidelines for contributing code or documentation to the project. This document will change over time, so make sure that your contributions still line up with the requirements here before submitting a pull request.

Caution

As of Pull Request #332 (SQLite Migration) the main branch will marked as experimental before full JSON to SQL parity is operational. Existing TagStudio libraries are not yet compatible with this change, however they will NOT be corrupted or deleted if opened with these versions. Once parity is reached and a stable conversion tool in place, this notice will be removed. UPDATE: As of November 19th, 2024, full parity is rapidly approaching.

For the most recent stable feature release branch, see the Alpha-v9.4 branch. These v9.4 specific features are currently being backported to the SQL-ized main branch. (Feel free to help!)

Getting Started

  • Check the Feature Roadmap page to see what priority features there are, the FAQ, as well as the open Issues and Pull Requests.
  • If you'd like to add a feature that isn't on the feature roadmap or doesn't have an open issue, PLEASE create a feature request issue for it discussing your intentions so any feedback or important information can be given by the team first.
    • We don't want you wasting time developing a feature or making a change that can't/won't be added for any reason ranging from pre-existing refactors to design philosophy differences.
  • Please don't create pull requests that consist of large refactors, especially without discussing them with us first. These end up doing more harm than good for the project by continuously delaying progress and disrupting everyone else's work.
  • If you wish to discuss TagStudio further, feel free to join the Discord Server

Contribution Checklist

Note

If the fix is small and self-explanatory (i.e. a typo), then it doesn't require an issue to be opened first. Issue tracking is supposed to make our lives easier, not harder. Please use your best judgement to minimize the amount of work involved for everyone involved.

Creating a Development Environment

Prerequisites

  • Python 3.12
  • Ruff (Included in requirements-dev.txt)
  • Mypy (Included in requirements-dev.txt)
  • PyTest (Included in requirements-dev.txt)

Creating a Python Virtual Environment

If you wish to launch the source version of TagStudio outside of your IDE:

Important

Depending on your system, Python may be called python, py, python3, or py3. These instructions use the alias python3 for consistency. You can check to see which alias your system uses and if it's for the correct Python version by typing python3 --version (or whichever alias) into your terminal.

Tip

On Linux and macOS, you can launch the tagstudio.sh script to skip the following process, minus the requirements-dev.txt installation step. Using the script is fine if you just want to launch the program from source.

  1. In the root repository directory, create a python virtual environment:
    python3 -m venv .venv
  2. Activate your environment:
  • Windows w/Powershell: .venv\Scripts\Activate.ps1
  • Windows w/Command Prompt: .venv\Scripts\activate.bat
  • Linux/macOS: source .venv/bin/activate
  1. Install the required packages:
  • pip install -r requirements.txt
  • If developing (includes Ruff and Mypy): pip install -r requirements-dev.txt

Learn more about setting up a virtual environment here.

Manually Launching (Outside of an IDE)

  • Windows (start_win.bat)

    • To launch TagStudio, launch the start_win.bat file. You can modify this .bat file or create a shortcut and add one or more additional arguments if desired.

  • Linux/macOS (TagStudio.sh)

    • Run the "TagStudio.sh" script and the program should launch! (Make sure that the script is marked as executable if on Linux). Note that launching from the script from outside of a terminal will not launch a terminal window with any debug or crash information. If you wish to see this information, just launch the shell script directly from your terminal with ./TagStudio.sh.

    • NixOS (Nix Flake)

      • Use the provided Flake to create and enter a working environment by running nix develop. Then, run the program via python3 tagstudio/tag_studio.py from the root directory.

Warning

Support for NixOS is still a work in progress.

  • Any (No Scripts)

    • Alternatively, with the virtual environment loaded, run the python file at tagstudio\tag_studio.py from your terminal. If you're in the project's root directory, simply run python3 tagstudio/tag_studio.py.

Workflow Checks

When pushing your code, several automated workflows will check it against predefined tests and style checks. It's highly recommended that you run these checks locally beforehand to avoid having to fight back-and-forth with the workflow checks inside your pull requests.

Tip

To format the code automatically before each commit, there's a configured action available for the pre-commit hook. Install it by running pre-commit install. The hook will be executed each time on running git commit.

Ruff

A Python linter and code formatter. Ruff uses the pyproject.toml as its config file and runs whenever code is pushed or pulled into the project.

Running Locally

Inside the root repository directory:

  • Lint code with ruff check
    • Some linting suggestions can be automatically formatted with ruff check --fix
  • Format code with ruff format

Ruff should automatically discover the configuration options inside the pyproject.toml file. For more information, see the ruff configuration discovery docs.

Ruff is also available as a VS Code extension, PyCharm plugin, and more.

Mypy

Mypy is a static type checker for Python. It sure has a lot to say sometimes, but we recommend you take its advice when possible. Mypy also uses the pyproject.toml as its config file and runs whenever code is pushed or pulled into the project.

Running Locally

  • First time only: Move into the /tagstudio directory with cd tagstudio and run the following:
    • mkdir -p .mypy_cache
    • mypy --install-types --non-interactive
  • Check code by moving into the /tagstudio directory with cd tagstudio (if you aren't already inside) and running mypy --config-file ../pyproject.toml .. (Don't forget the . at the end!)

Mypy is also available as a VS Code extension, PyCharm plugin, and more.

PyTest

  • Run all tests by moving into the /tagstudio directory with cd tagstudio and running pytest tests/.

Code Style

Most of the style guidelines can be checked, fixed, and enforced via Ruff. Older code may not be adhering to all of these guidelines, in which case "do as I say, not as I do"...

  • Do your best to write clear, concise, and modular code.
  • Keep a maximum column with of no more than 100 characters.
  • Code comments should be used to help describe sections of code that can't speak for themselves.
  • Use Google style docstrings for any classes and functions you add.
    • If you're modifying an existing function that does not have docstrings, you don't have to add docstrings to it... but it would be pretty cool if you did ;)
  • Imports should be ordered alphabetically.
  • Lists of values should be ordered using their natural sort order.
    • Some files have their methods ordered alphabetically as well (i.e. thumb_renderer). If you're working in a file and notice this, please try and keep to the pattern.
  • When writing text for window titles or form titles, use "Title Case" capitalization. Your IDE may have a command to format this for you automatically, although some may incorrectly capitalize short prepositions. In a pinch you can use a website such as capitalizemytitle.com to check.
  • If it wasn't mentioned above, then stick to PEP-8!

Modules & Implementations

  • Avoid direct calls to os
    • Use Pathlib library instead of os.path
    • Use platform.system() instead of os.name and sys.platform
  • Don't prepend local imports with tagstudio, stick to src
  • Use the logger system instead of print statements
  • Avoid nested f-strings
  • Use HTML-like tags inside Qt widgets over stylesheets where possible.

Commit and Pull Request Style

  • Use Conventional Commits as a guideline for commit messages. This allows us to easily generate changelogs for releases.
    • See some examples of what this looks like in practice.
  • Use clear and concise commit messages. If your commit does too much, either consider breaking it up into smaller commits or providing extra detail in the commit description.
  • Pull requests should have an adequate title and description which clearly outline your intentions and changes/additions. Feel free to provide screenshots, GIFs, or videos, especially for UI changes.
  • Pull requests should ideally be limited to a single feature or fix.

Tip

If you're unsure where to stop the scope of your PR, ask yourself: "If I broke this up, could any parts of it still be used by the project in the meantime?"

Runtime Requirements

  • Final code must function on supported versions of Windows, macOS, and Linux:
    • Windows: 10, 11
    • macOS: 12.0+
    • Linux: Varies
  • Final code must NOT:
    • Contain superfluous or unnecessary logging statements.
    • Cause unreasonable slowdowns to the program outside of a progress-indicated task.
    • Cause undesirable visual glitches or artifacts on screen.

Documentation Guidelines

Documentation contributions include anything inside of the docs/ folder, as well as the README.md and CONTRIBUTING.md files. Documentation inside the docs/ folder is built and hosted on our static documentation site, docs.tagstud.io.

  • Use "snake_case" for file and folder names
  • Follow the folder structure pattern
  • Don't add images or other media with excessively large file sizes
  • Provide alt text for all embedded media
  • Use "Title Case" for title capitalization

Translation Guidelines

Translations are performed on the TagStudio Weblate project.

Translation guidelines coming soon.