mirror of
https://github.com/Flowseal/tg-ws-proxy.git
synced 2026-09-05 18:16:11 +03:00
delewer
63 lines
1.3 KiB
Markdown
63 lines
1.3 KiB
Markdown
# CONTRIBUTING
|
|
|
|
Thank you for wanting to help the `tg-ws-proxy` project.
|
|
|
|
## Before Creating an Issue
|
|
|
|
1. Check the documentation in `docs/README.md`.
|
|
2. Make sure a similar issue hasn't already been opened.
|
|
3. Use standard labels from `.github/labels.md` for correct triage.
|
|
|
|
## How to Report Problems
|
|
|
|
- Use the `Problem` template.
|
|
- If possible, provide:
|
|
- Application version,
|
|
- Operating system,
|
|
- Steps to reproduce,
|
|
- Expected and actual behavior,
|
|
- Log file or error text.
|
|
|
|
The more precise your description, the faster we can help.
|
|
|
|
## Local Development from Source
|
|
|
|
Python `>=3.8` is required.
|
|
|
|
```bash
|
|
pip install -e .
|
|
```
|
|
|
|
Running:
|
|
|
|
- console mode: `tg-ws-proxy`
|
|
- Windows tray: `tg-ws-proxy-tray-win`
|
|
- macOS tray: `tg-ws-proxy-tray-macos`
|
|
- Linux tray: `tg-ws-proxy-tray-linux`
|
|
|
|
Details: `docs/BuildFromSource.md`.
|
|
|
|
## Checks
|
|
|
|
Tests use the standard library only, no extra dependencies:
|
|
|
|
```bash
|
|
python -m unittest discover -s tests -t .
|
|
```
|
|
|
|
Linting (`ruff` is configured in `pyproject.toml`):
|
|
|
|
```bash
|
|
ruff check .
|
|
```
|
|
|
|
## Pull Request
|
|
|
|
Before opening a PR:
|
|
|
|
1. Make sure your change solves a specific problem.
|
|
2. Check that existing scenarios aren't broken; run the tests and the linter.
|
|
3. Update documentation if behavior or configuration changes.
|
|
|
|
Smaller and focused PRs are reviewed and accepted faster.
|