Skip to main content

Contributing

FOLDR contributions should be focused, tested, and documented. The FOLDR project page is the canonical place to find the current project and source links. Use the active repository URL published there rather than an old or archived remote.

Set up a development environment​

Clone the active source repository, then move into its project directory:

git clone <active-repository-url>
cd <repository-directory>

Create and activate a virtual environment:

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

On Windows PowerShell, activate it with:

.\.venv\Scripts\Activate.ps1

Install the development dependencies:

python -m pip install -e ".[dev]"

Validate your changes​

Run the test suite:

python -m pytest tests/ -v

Before proposing a change, also check formatting and any project-specific verification scripts included in the repository.

Pull request guidelines​

  • Keep each change focused on one feature, fix, or documentation improvement.
  • Add regression tests for behavior changes and bug fixes.
  • Update the relevant guides and command reference when CLI behavior changes.
  • Include a clear explanation of the problem and the expected behavior.

Bug reports​

Include the operating system, Python version, FOLDR version, exact command, expected result, actual result, and relevant logs. Remove personal file paths or other private information before sharing logs.