Skip to content

Contributing.md

Latest commit

 

History

History
46 lines (35 loc) · 1.43 KB

Contributing.md

File metadata and controls

46 lines (35 loc) · 1.43 KB

Contributing to Hashium

Thank you for your interest in contributing to Hashium! We welcome all kinds of contributions — bug reports, feature requests, documentation improvements, and code contributions.

Getting Started

  1. Fork the Repository: Click the "Fork" button on the top right of the GitHub page.
  2. Clone Your Fork: Use the following command to clone your fork: 
    git clone https://github.com/your-username/Hashium.git
cd Hashium
  3. Set Up a Virtual Environment (optional but recommended): 
    python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate
pip install -r requirements.txt

Making Changes

  • Follow the PEP8 style guide for Python code.
  • Write clear, concise commit messages.
  • Add or update tests for your code if applicable.
  • Test your changes locally before pushing.

Submitting a Pull Request

  1. Create a new branch for your changes: 
    git checkout -b your-branch-name
  2. Make your changes and commit them.
  3. Push the branch to your fork: 
    git push origin your-branch-name
  4. Open a pull request against the main branch of Hashium.

Code of Conduct

Be respectful, inclusive, and considerate in all interactions.

Need Help?

If you have questions, feel free to open an issue or reach out via discussions.