Open Source
Join the NoiseFramework Community
NoiseFramework is open source and welcomes contributions from everyone
How You Can Help
First-Time Contributors Welcome!
- 1
Read the Code of Conduct
Be respectful, constructive, and professional. We're building a cryptographic library that users trust with their security.
- 2
Check existing issues for good first issues
Look for issues tagged with "good first issue" or "help wanted"
- 3
Fork the repository
Create your own fork to work on changes
- 4
Make your changes
Follow our coding guidelines and write tests
- 5
Submit a pull request
Describe your changes clearly and link to any related issues
Development Guidelines
✅ Good PRs
- •Solve one problem clearly
- •Include comprehensive tests
- •Follow existing code style
- •Update documentation
- •Have descriptive commit messages
❌ Avoid
- •Multiple unrelated changes in one PR
- •Breaking existing APIs without discussion
- •Missing tests
- •Unformatted code
- •Security vulnerabilities
Development Setup
# Clone repository
git clone https://github.com/juliuspleunes4/noiseframework.git
cd noiseframework
# Setup environment
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
# Install dependencies
pip install -e ".[dev]"
# Run tests
pytest tests/
# Format code
black noiseframework/ tests/
# Type checking
mypy noiseframework/Get in Touch
Project Stats
View on
GitHub
Fork
Repository
Open
Issues
Join
Contributors
License
Thank You!
Thank you for helping make NoiseFramework better and more secure! 🔒