Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

94 lines (68 loc) · 4.17 KB

Contributing to Universal Quantum Network (UQN)

Thank you for your interest in contributing to the Universal Quantum Network (UQN) project! We welcome contributions from the community and appreciate your efforts to help improve the project. Please follow the guidelines below to ensure a smooth contribution process.

Table of Contents

Getting Started

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page to create your own copy of the project.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    1 git clone https://github.com/KOSASIH/UniversalQuantumNetwork.git
2 cd UniversalQuantumNetwork

  3. Create a Branch: Create a new branch for your feature or bug fix.

    1 git checkout -b feature/your-feature-name

Reporting Issues

If you encounter any bugs or have feature requests, please report them using the following steps:

  1. Check Existing Issues: Before creating a new issue, check the issues section to see if your issue has already been reported.

  2. Create a New Issue: If your issue is not listed, click on the "New Issue" button and provide the following information:

    • A clear and descriptive title.
    • A detailed description of the issue, including steps to reproduce it.
    • Any relevant screenshots or error messages.

  3. Code Contributions To contribute code to the UQN project, please follow these steps:

  4. Make Your Changes: Implement your changes in your local branch.

  5. Test Your Changes: Ensure that your changes do not break existing functionality. Run the tests provided in the tests/ directory.

  6. Add New Tests: If you are adding new features, consider adding tests to cover your changes.

Documentation Contributions

We appreciate contributions to the documentation! If you notice any errors or have suggestions for improvement, please follow the same process as for code contributions:

  1. Edit Documentation: Make your changes in the appropriate documentation files located in the docs/ directory.
  2. Preview Changes: If possible, preview your changes to ensure they render correctly.

Coding Standards

To maintain code quality and consistency, please adhere to the following coding standards:

  • Follow PEP 8 for Python code style.
  • Use meaningful variable and function names.
  • Write clear and concise comments to explain complex logic.
  • Organize code into functions and classes where appropriate.

Commit Messages

When committing your changes, please use clear and descriptive commit messages. Follow this format:

1 [Type] Short description of the change
2 
3 Detailed explanation of the change, if necessary. Include any relevant issue numbers.

Types:

  • Fix: A bug fix.
  • Feature: A new feature or enhancement.
  • Docs: Documentation changes.
  • Test: Adding or updating tests.
  • Chore: Other changes that do not modify src or test files.

Pull Request Process

  1. Push Your Changes: Push your changes to your forked repository.

    1 git push origin feature/your-feature-name

  2. Open a Pull Request: Go to the original repository and click on the "Pull Requests" tab. Click "New Pull Request" and select your branch.

  3. Provide a Description: Fill out the pull request template, providing a clear description of your changes and any relevant context.

  4. Review Process: Your pull request will be reviewed by the project maintainers. Be open to feedback and make any necessary changes.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We are committed to providing a welcoming and inclusive environment for all contributors.

Thank you for contributing to the Universal Quantum Network project! Your efforts help us build a better and more advanced quantum communication framework.