This document provides guidelines for contributing to the CryptoNoise-Ksampler project, including a code of conduct, development setup instructions, and the pull request process.
2.4 KiB
2.4 KiB
Contributing to CryptoNoise-Ksampler
Thank you for your interest in contributing to CryptoNoise-Ksampler! This document provides guidelines and instructions for contributing to the project.
Code of Conduct
This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please see the CODE_OF_CONDUCT.md file for details.
Getting Started
- Fork the repository
-
- Clone your fork locally
-
- Create a new branch for your feature or bugfix
-
- Make your changes
-
- Write or update tests as needed
-
- Commit your changes with clear, descriptive messages
-
- Push to your fork
-
-
Submit a Pull Request
-
Development Setup
-
git clone https://github.com/[your-username]/CryptoNoise-Ksampler.git cd CryptoNoise-Ksampler pip install -r requirements.txtReporting Issues
When reporting issues, please include:
- A clear description of the problem
-
- Steps to reproduce (if applicable)
-
- Expected and actual behavior
-
- Python version and system information
-
-
Relevant code or configuration
-
Pull Request Process
-
- Update documentation for any new features
-
- Add tests for new functionality
-
- Ensure all tests pass
-
- Update the CHANGELOG.md
-
- Follow the existing code style
-
-
Write clear, descriptive commit messages
-
License
-
By contributing, you agree that your contributions will be licensed under the same license as the project (BY-NC 4.0).
-
-
-