@@ -75,22 +75,54 @@ local git repository using the following command:
7575git commit -s
7676```
7777
78- <!--
79- ## Communication
80- **FIXME** Please feel free to connect with us on our [Slack channel](link).
81-
8278## Setup
83- **FIXME** Please add any special setup instructions for your project to help the developer
84- become productive quickly.
85-
86- ## Testing
87- **FIXME** Please provide information that helps the developer test any changes they make
88- before submitting.
8979
90- ## Coding style guidelines
91- **FIXME** Optional, but recommended: please share any specific style guidelines you might
92- have for your project.
93- -->
80+ 1 . ** Clone the repository and install dependencies:**
81+ ``` shell
82+ git clone https://github.com/instana/python-sensor.git
83+ cd python-sensor
84+ pip install -e " .[dev]"
85+ ```
86+
87+ This installs the package in editable mode with development dependencies (pytest, ruff, pre-commit, etc.)
88+
89+ 2 . ** Set up pre-commit hooks:**
90+ ``` shell
91+ pre-commit install
92+ ```
93+
94+ This automatically runs Ruff linter and formatter before each commit.
95+
96+ ## Testing and Code Quality
97+
98+ Before submitting a pull request:
99+
100+ 1 . ** Run tests:**
101+ ``` shell
102+ pytest
103+ ```
104+
105+ 2 . ** Check code style:**
106+ ``` shell
107+ ruff check ./src ./tests ./tests_aws
108+ ```
109+
110+ Or run all pre-commit checks:
111+ ``` shell
112+ pre-commit run --all-files
113+ ```
114+
115+ ** Note:** All pull requests to ` main ` must pass GitHub Actions checks (Ruff linter + test suite).
116+
117+ ## Coding Style
118+
119+ - Python 3.9+ compatible code
120+ - Follow PEP 8 style guidelines (enforced by Ruff)
121+ - Include copyright headers in new files (see [ Legal] ( #legal ) section)
122+ - Use type hints where appropriate
123+ - Ruff automatically formats code on commit via pre-commit hooks
124+
125+ Configuration is defined in [ ` pyproject.toml ` ] ( pyproject.toml ) . For advanced Ruff usage, see [ Ruff documentation] ( https://docs.astral.sh/ruff/ ) .
94126
95127<!-- Reference links -->
96128
0 commit comments