Skip to content

Commit 3987a6d

Browse files
authored
👌 IMPROVE: CONTRIBUTING.md
1 parent c3f7590 commit 3987a6d

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ Thank you for your interest in contributing to the Langbase Python SDK! We welco
5050
5151
## Before You Commit
5252
53-
**IMPORTANT**: All code must pass quality checks before committing. Run these commands:
54-
5553
### Format Your Code
5654
```bash
5755
# Auto-format with Black (required)
@@ -61,8 +59,7 @@ black langbase/ tests/ examples/
6159
isort langbase/ tests/ examples/
6260
```
6361
64-
65-
### 4. Run Tests
62+
### Run Tests
6663
```bash
6764
# Run all tests
6865
pytest
@@ -77,13 +74,13 @@ pytest tests/test_pipes.py
7774
pytest -v
7875
```
7976
80-
### 5. Run All Checks at Once
77+
### Run All Checks at Once
8178
```bash
8279
# This runs all pre-commit hooks (black, isort)
8380
pre-commit run --all-files
8481
```
8582
86-
### 6. Release a New Version
83+
### Release a New Version
8784
8885
The release process is automated with an interactive script. **Only maintainers should create releases.**
8986
@@ -159,10 +156,12 @@ git commit -m "📖 DOC: Improved contribution docs"
159156
```
160157
161158
Follow conventional commit format:
162-
- `📦 NEW:` New feature
163-
- `🐛 BUG:` Bug fix
164-
- `📖 Docs:` Documentation changes
165-
- `👌🏻 IMP:` Improvements
159+
- `📦 NEW:` New feature.
160+
- `👌IMPROVE:` Improvements.
161+
- `🐛 BUG:` Bug fix.
162+
- `📖 Docs:` Documentation changes.
163+
- `🚀 RELEASE`: Release new version.
164+
166165
167166
### 6. Push and Create PR
168167
```bash

0 commit comments

Comments
 (0)