-
Notifications
You must be signed in to change notification settings - Fork 4
Add developer guide #252
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add developer guide #252
Conversation
…fore launching GUI
…sed by the dev/generate_keypoing_legend.py script)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive developer documentation to JABS, split into CONTRIBUTING.md and DEVELOPMENT.md, along with the addition of a --version flag to the jabs command, improved type hints, and reorganization of the matplotlib dependency.
Key changes:
- New contributor and developer documentation files with copyright assignment to The Jackson Laboratory
- Comprehensive technical guide covering feature extraction architecture, FEATURE_VERSION management, and jabs-cli consolidation strategy
- Added --version flag to jabs command for version information access
- Fixed type hints across feature extraction modules (dict[str, type[Feature]])
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | New contributor guide with copyright assignment, quick-start setup, and submission guidelines |
| docs/DEVELOPMENT.md | New comprehensive technical documentation (~1,100 lines) covering architecture, feature extraction, CLI tools, and development workflow |
| README.md | Updated to reference new documentation files and streamline developer setup section |
| src/jabs/scripts/gui_entrypoint.py | Added --version flag and moved argument parsing before QApplication initialization |
| pyproject.toml | Moved matplotlib from test to dev dependency group |
| src/jabs/feature_extraction/*/group.py | Fixed type hint from dict[str, Feature] to dict[str, type[Feature]] |
| docs/user-guide.md | Moved from src/jabs/resources/docs/user_guide/user-guide.md with updated relative paths |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| We recommend installing JABS in a dedicated Python virtual environment. | ||
| This section describes how to install JABS as an end user. Developers should see the | ||
| [JABS Development](#jabs-development) section below for instructions on setting up a development environment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might not be ready for this PR, but I tested using jabs with uvx and it worked really nicely!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've also used pipx
Add Developer Documentation (CONTRIBUTING.md and DEVELOPMENT.md)
Summary
This PR adds comprehensive developer documentation split into two files:
Key Changes
New Files:
Documentation Highlights:
Other Changes:
Benefits
Testing