Files
Shadowwalker 1af510c892 Add contributing guidelines to CONTRIBUTING.md
This document provides guidelines for contributing to the CryptoNoise-Ksampler project, including a code of conduct, development setup instructions, and the pull request process.
2025-12-23 05:55:35 +00:00

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

  1. Fork the repository
    1. Clone your fork locally
      1. Create a new branch for your feature or bugfix
        1. Make your changes
          1. Write or update tests as needed
            1. Commit your changes with clear, descriptive messages
              1. Push to your fork
                1. Submit a Pull Request

                2. Development Setup

                3. git clone https://github.com/[your-username]/CryptoNoise-Ksampler.git
                  cd CryptoNoise-Ksampler
                  pip install -r requirements.txt
                  

                  Reporting 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

                            1. Update documentation for any new features
                              1. Add tests for new functionality
                                1. Ensure all tests pass
                                  1. Update the CHANGELOG.md
                                    1. Follow the existing code style
                                      1. Write clear, descriptive commit messages

                                      2. License

                                      3. By contributing, you agree that your contributions will be licensed under the same license as the project (BY-NC 4.0).