Merge pull request #117 from djarecka/contribute

adding a simple instuctions for developers

Author: djarecka

.github/workflows/test.yaml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] # For demonstration, other OSes are commented out: macos-latest, windows-latest
-        python-version: ['3.12', '3.11', '3.10']
+        python-version: ['3.13', '3.12', '3.11', '3.10']
     steps:
     - uses: actions/checkout@v4
       with:  # no need for the history

CONTRIBUTING.md

@@ -1,12 +1,10 @@
-# pipepal pull request guidelines
+# Contributing to StructSense
 
-Pull requests are always welcome, and we appreciate any help you give. Note that a code of conduct applies to all spaces managed by the pipepal project, including issues and pull requests. Please see the [Code of Conduct](CODE_OF_CONDUCT.md) for details.
+Pull requests are always welcome, and we appreciate any help you give. Note that a code of conduct applies to all spaces managed by the StructSense project, including issues and pull requests. Please see the [Code of Conduct](CODE_OF_CONDUCT.md) for details.
 
 When submitting a pull request, we ask you to check the following:
 
 1. **Unit tests**, **documentation**, and **code style** are in order.
-   See the Continuous Integration for up to date information on the current code style, tests, and any other requirements.
+   See the [Developer Guide](DEVELOPER.md) for setup instructions and testing.
 
-   It is also OK to submit work in progress if you're unsure of what this exactly means, in which case you'll likely be asked to make some further changes.
-
-2. The contributed code will be **licensed under the same [license](LICENSE) as the rest of the repository**, If you did not write the code yourself, you must ensure the existing license is compatible and include the license information in the contributed files, or obtain permission from the original author to relicense the contributed code.
+2. The contributed code will be **licensed under the same [license](LICENSE.txt) as the rest of the repository**. If you did not write the code yourself, you must ensure the existing license is compatible and include the license information in the contributed files, or obtain permission from the original author to relicense the contributed code.

DEVELOPER.md

@@ -1,4 +1,47 @@
-# StructSense Information for Developer
+# StructSense Developer Guide
+
+## Development Setup
+
+### Requirements
+
+- Python 3.10-3.13
+- [Poetry](https://python-poetry.org/) >= 2.0
+
+### Install
+
+```bash
+git clone https://github.com/sensein/structsense.git
+cd structsense
+poetry install --with dev
+```
+
+### Environment Variables
+
+Create a `.env` file in the project root:
+
+```bash
+# required for LLM calls
+OPENROUTER_API_KEY=your-key-here
+# optional, only for BioPortal concept mapping
+BIOPORTAL_API_KEY=your-key-here
+```
+
+### Pre-commit Hooks
+
+```bash
+poetry run pre-commit install
+```
+
+### Running Tests
+
+```bash
+poetry run pytest                                      # all tests (requires OPENROUTER_API_KEY)
+poetry run pytest -m "not requires_openrouter"         # unit tests only
+```
+
+---
+
+## Architecture Overview
 
 This document provides the overview of the major **StructSense** component and flow.