Skip to content

Commit 637fc9e

Browse files
author
Spyros Lefkaditis
committed
Update CONTRIBUTING.md with current setup instructions
- Add ./init.sh script usage for development setup - Update testing instructions with modern examples - Include configuration management testing - Add quick start guide for contributors - Align with current repository structure and practices
1 parent 5e09a11 commit 637fc9e

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,47 @@ Security is paramount for FibroHash. When contributing security-related changes:
3737

3838
## Development Process
3939

40+
### Quick Start for Contributors
41+
42+
```bash
43+
# Get started immediately
44+
git clone https://github.com/SpyrosLefkaditis/fibrohash.git
45+
cd fibrohash
46+
./init.sh --version # Verify setup
47+
./init.sh --test # Run test suite
48+
```
49+
4050
### Setting Up Development Environment
4151

4252
```bash
53+
# Clone the repository
4354
git clone https://github.com/SpyrosLefkaditis/fibrohash.git
4455
cd fibrohash
45-
python3 -m pip install -e .[dev]
56+
57+
# Quick setup using the initialization script
58+
./init.sh
59+
60+
# Or manual setup
61+
python3 -m pip install -e .
62+
63+
# Verify installation
64+
python3 -c "from main import generate_password; print('Development environment ready!')"
4665
```
4766

4867
### Running Tests
4968

5069
```bash
51-
# Run all tests
70+
# Run all tests using the init script
71+
./init.sh --test
72+
73+
# Or run tests directly
5274
python3 test.py
5375

54-
# Run security audit
55-
python3 -c "from security_utils import generate_security_report; print('Security tests passed')"
76+
# Run security audit and generate report
77+
python3 -c "from main import generate_password; from security_utils import generate_security_report; pwd = generate_password('test', 32, 'high'); report = generate_security_report(pwd); print('Security tests passed!')"
78+
79+
# Test configuration management
80+
python3 -c "from config import get_config; config = get_config(); print(f'Config loaded: {config.get_security_param(\"default_security_level\")}')"
5681
```
5782

5883
### Code Style

0 commit comments

Comments
 (0)