Contributing Guidelines for VueTorrent

Thank you for considering contributing to VueTorrent! We need volunteers from all kind to keep an up-to-date experience for everyone using the project, not just developers 😉!

Come find us on Discord to get in touch with the community! Whether it is for showing your support, contributing or asking questions about features and bugs you're welcome to come chat with us.

Here are some guidelines to follow:

Reporting Bugs

Before submitting a bug report, search the issue tracker to see if the issue has already been reported. If it has, add any additional helpful details to the existing issue.

If the bug has not yet been reported, create a new issue by following issue templates in place and include as much detail as possible including steps to reproduce the bug, expected behavior, and any relevant information concerning VueTorrent or qBittorrent codebase that may be related to the root cause.

Suggesting Enhancements

Enhancement suggestions are welcome! Check the issue tracker to see if your idea has already been suggested. If it has, add your support by commenting on the existing issue.

If it is a new idea, open a new issue providing as much detail about your enhancement as possible. Explaining how it will improve or add value specifically to VueTorrent. Any code samples, mockups, or documentation are encouraged.

Pull Requests

Follow these steps for submitting a pull request to VueTorrent:

Fork the VueTorrent/VueTorrent repository and create your branch from master.
Describe your proposed changes in the pull request description. Link to any related issues.
Make sure the pull request only includes changes related to your enhancement or bug fix.
Follow the existing code style and conventions used in the VueTorrent codebase and don't forget to npm run lint your changes!
Run existing tests and write new tests for your changes as needed.
Open the pull request!

VueTorrent maintainers will review it and provide feedback if additional changes are needed. When everything's good, we'll merge your PR!

Don't hesitate to create your PR in draft mode if you need some feedback

Localization

VueTorrent welcomes localization contributions!

We no longer accept PRs for translations as all locale data in this repo is there only for reference and building from source. Instead head to our Discord server or contact us directly by mail to get your invitation link to the Tolgee project.

Wiki changes

To propose changes to the project's wiki, you can open an issue using the "Wiki edit proposal" template.

Provide a description of which part of the documentation this proposal will address.
Attach changes by following the field's description.

2.9 KiB Raw Blame History