Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.61 KB

CONTRIBUTE.md

File metadata and controls

66 lines (44 loc) · 2.61 KB
Raw

Contributing to Dxns Hub Quantum Energy Project

Thank you for considering contributing to the Harmonic Balancer Project! We welcome contributions from the community and are grateful for your support.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem or suggestion.
  • Steps to reproduce the issue (if applicable).
  • Any relevant screenshots or code snippets.

Submitting Pull Requests

We welcome pull requests for bug fixes, improvements, and new features. To submit a pull request:

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/dxns-hub/GrapheneEnergyLabs.git

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes to the codebase. Ensure that your code follows the project's coding standards and includes appropriate tests.

  5. Commit Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Add feature: your feature description"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  7. Open a Pull Request: Go to the original repository on GitHub and open a pull request. Provide a clear and descriptive title and description for your pull request.

Coding Standards

Please ensure that your code adheres to the following standards:

  • Code Style: Follow the PEP 8 style guide for Python code.
  • Documentation: Include docstrings for all functions and classes. Update the README and any other relevant documentation if necessary.
  • Testing: Write unit tests for your code and ensure that all tests pass. Run the tests using: 
    python -m unittest discover tests

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to dxn000@gmail.com.

Getting Help

If you need help or have any questions, feel free to reach out by opening an issue on GitHub or contacting matt@amiai.foundation.

Thank you for your contributions!