Contributing to XSNAP#

Thank you for your interest in contributing to XSNAP!

We welcome all types of contributions—bug reports, feature requests, code patches, documentation improvements, and examples.

How to get involved:

  1. File an issue

    On our GitHub Issue tracker: Please describe the problem you found or feature you would like to see.

  2. Submit a pull request against the main branch.

    1. Fork the XSNAP repository on GitHub.

    2. Clone your fork and install in “editable” mode:

      git clone https://github.com/<your_username>/XSNAP.git
      cd XSNAP
      pip install -e .
      
    3. Make your changes, then stage and commit:

      git add .
      git commit -m "Brief description of your changes"
      
    4. Push and open a PR against the upstream main:

      git push origin main
      

      Then go to your fork on GitHub and click “Compare & pull request” to target fercananything/XSNAP:main.

  3. Discuss on email

    If you prefer, feel free to send any inquiries directly to support@xsnap.org.

We’re in the early stages of XSNAP’s development, so every bit of feedback and contribution helps.

Thank you for making XSNAP better!