Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2025-01-26 14:36:03 -05:00
Code Issues Packages Projects Releases Wiki Activity
onionshare/CONTRIBUTING.md
Philemon Johnson 1863e9eb84 Create CONTRIBUTING.md
2024-09-23 15:48:38 +05:30

1.0 KiB
Raw Blame History

Setup

Contributing to OnionShare

Prerequisites

  1. Python 3
  2. Poetry
  3. Tor (package; you would also need tor browser is needed for desktop)
  4. Go (for desktop)

Setting Up the Codebase

Clone the repository:

git clone https://github.com/onionshare/onionshare.git
cd onionshare

1. Setting Up the CLI (Required for Desktop)

Follow the setup instructions in cli/Readme.md:

cd cli
poetry install

2. Setting Up the Desktop

Navigate to the Desktop directory and follow the setup instructions in desktop/Readme.md:

cd ../desktop
poetry install

3. Running OnionShare

Run the desktop application:

poetry run onionshare-gui

Make sure Tor is running before starting OnionShare:

tor

Contribution Guidelines

  1. Fork the repository and create a branch from main.
  2. Write clear commit messages.
  3. Run tests before submitting a pull request (PR).
  4. Open a PR to the main branch.
  5. Follow the Code of Conduct.