Contributor Guide

Not a coder? Not a problem! FlexGet is multi-faceted, and we can use a lot of help. These are all activities we’d like to get help with (they’re all important, so we list them in alphabetical order):

• Code maintenance and development

• Developing educational content & narrative documentation

• Translating content

• Website design and development

• Writing technical documentation

Getting started

• Development environment setup
  • Cloning the repository
  • Installing uv
  • Installing dependencies using uv sync
  • Setting up prek
  • Linking your repository to the upstream repo
• Understanding the code
  • Our development stack
  • Libraries we use
• Development workflow
  • Basic workflow
  • Additional things you might want to do

Topic guides

• Running and writing tests
  • Running the tests
  • Testing a plugin
  • Testing network-dependent code
  • Provided fixtures and marks
  • Mock input
  • Controlling plugin behavior in tests with task.options
  • Code coverage
  • Inject
  • Commandline values
• Database
  • Migrations
  • Database cleanups
• Plugin schemas
  • Keywords
• List interface
  • Usage
  • Overridden methods
  • Custom methods
  • Plugin format
• Docstrings and documentation
  • Contributing to docstrings
  • Contributing to the user wiki
  • Building and contributing to the documentation
• Generating distribution archives
  • Steps to generate distribution packages
• Maintainer guide
  • Python version bump checklist
  • Triggering a manual release

Team practices

• Merge and review policy
  • Policy for moderate changes
  • Policy for major new features and breaking changes
  • Policy For minor changes and bugfixes
• Making releases
  • Our goals
  • Making a release
  • Choosing a version increment
• Supported Python versions

About the project

• Contributors and collaborators
  • Contributors to this tool
  • Collaborators on the repository