Developer & Contributor Docs

Use this page as your landing point for development setup, code architecture, and contribution guidelines. Follow the linked pages in order so you can move from setup to contributing without guessing the next step.

This section covers:

• Development Guide — Environment setup, running tests, submitting changes

• Architecture and Design — How py3plex is organized internally (modules, data flow, extension points)

• Repository Layout — Directory structure and where key files live

• Contributing to py3plex — Bug reports, code style, review process

Types of Contributions

• Bug reports — Include steps to reproduce, expected vs. actual behavior, and environment details (OS, Python, py3plex version)

• Documentation — Improve explanations, runnable examples, and doc tests

• Code fixes — Address bugs, safety gaps, or performance bottlenecks

• New features — Add algorithms, visualizations, I/O formats, or plugins

• Examples — Write tutorials and end-to-end workflows others can run locally

• Community support — Help others in issues and discussions with concrete guidance

Getting Started

1. Read Development Guide to set up your environment and workflow.

2. Pick a small, scoped task (docs, tests, or a single bug) to get familiar with the process.

3. Browse GitHub issues labeled “good first issue” or propose a doc improvement you can finish quickly.

4. Comment on the issue you plan to tackle so others know it is in progress, and keep the thread updated with findings.

5. Ask questions in the relevant issue or discussion thread when blocked; link any experiments or logs that help others assist you.

See Contributing to py3plex for the complete process.