Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.58 KB

Contributing to Torrench

Thank you for taking time to contribute to this project. Let's begin.

Did you find a bug?

  • Please make sure the bug was not already reported in issues
  • If no such bug is found, Open a new issue. Specify details of bug, making it as clear as possible.
  • LOGS - Attach the log file. Very important!
  • Finally, add a bug label to the issue.

Do you want to add a new module/website support?

  • Adding a new website should not be difficult. Please refer existing website modules (torrench/modules/*) to get an idea about code management. Stuck somewhere? Got suggestions? Ping me!

Did you write a patch (bug fix, new module, code optimisation...)?

  • Open a new Pull Request (PR) with the patch.
  • Ensure the PR clearly describes the problem and solution.
  • Ensure code follows PEP8 code-style.

Got feature requests?

  • Feature requests are welcome. However, I cannot promise if/when they will be added. Please Open a new issue stating the feature, and let's see where it goes.
  • Add enhancement tag to the issue.

Suggestions/Feedbacks/Contact

  • Suggestions/feedbacks are more than welcome. They keep me motivated and help keeping this project running.
  • You can DM me on Twitter, contact me directly through mail or ping me on Telegram. I am more responsive on these platforms.

HAPPY TORRENTING!