Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (73 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

110 lines (73 loc) · 3.36 KB
Raw

Contributing

Thank you for your interest in v2RayTun.

This repository is used for public roadmap, releases, bug reports, feature requests, and platform-specific notes.

It does not contain the application source code.

Before opening an issue

Before creating a new issue:

  • Check existing issues to avoid duplicates
  • Make sure the issue is related to v2RayTun
  • Use the correct issue template
  • Include enough details to reproduce or understand the problem

Issue types

Use GitHub Issues for:

  • Bug reports
  • Feature requests
  • Platform-specific problems
  • Roadmap suggestions
  • Release-related problems

Bug reports

When reporting a bug, please include:

  • Platform
  • App version
  • Operating system version, including device model and vendor UI version if applicable, for example Android version, phone model, and MIUI / One UI / ColorOS version
  • Where the app was installed from, for example Google Play, App Store, or APK file
  • Steps to reproduce the problem
  • Expected behavior
  • Actual behavior
  • Logs or screenshots, if available

Feature requests

When suggesting a feature, please include:

  • Target platform
  • Problem description
  • Expected behavior
  • Use case
  • Possible alternatives, if any

A feature request may be accepted, planned, declined, or left for future review.

Roadmap suggestions

Roadmap suggestions are reviewed together with other issues.

A roadmap item may use one of the following statuses:

Status Meaning
Needs review New item that has not been reviewed yet
Accepted The idea or issue is valid, but not scheduled yet
Planned The item is planned for development
In progress Work has started
Done The item has been completed or released
Declined The item is not planned for implementation

Declined items

Declined items may remain visible when possible.

This helps users understand which ideas were reviewed and why they are not currently planned.

Common reasons for declining an item may include:

  • The request does not match the current product direction
  • The feature would be too difficult to maintain
  • The platform does not support the required behavior
  • The feature has security, privacy, or compatibility concerns
  • There is already an alternative solution

Pull requests

This repository does not contain the application source code.

Pull requests may be used for:

  • Fixing documentation
  • Updating platform notes
  • Improving issue templates
  • Improving roadmap or release documentation

Pull requests that attempt to add or modify application source code may be reviewed on a case-by-case basis, but this repository is primarily intended for roadmap, releases, issues, and documentation.

Support scope

v2RayTun does not provide ready-made configs, subscriptions, proxy servers, or VPN services.

Please do not open issues asking for:

  • Ready-made configs
  • Free proxy servers
  • Subscription links
  • Help bypassing third-party service restrictions

Issues should be related to the application itself, its releases, platform behavior, bugs, or feature requests.

Language

Пояснения на русском языке могут добавляться там, где это помогает пользователям понять особенности конкретной платформы, решения, касающиеся планов развития, или примечания.