From e1d06bbc4bc31b39b47cad1fd1428afe5cb10fe5 Mon Sep 17 00:00:00 2001
From: Sen ZmaKi <phidelalvin@gmail.com>
Date: Sun, 1 Dec 2024 07:17:19 +0300
Subject: [PATCH] Add contribution guidelines

---
 .gitignore              |  5 +++--
 .todo                   |  6 ++++++
 .vscode/extensions.json | 10 ++++++++++
 README.md               | 15 +++++++++++++--
 pyproject.toml          |  3 +++
 5 files changed, 35 insertions(+), 4 deletions(-)
 create mode 100644 .todo
 create mode 100644 .vscode/extensions.json

diff --git a/.gitignore b/.gitignore
index 31f4930..bfbda3b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,5 @@
 .dev-garbage/
 .setup-scripts/
-.vscode/
 .venv/
 .venv-termux
 tests/
@@ -13,8 +12,10 @@ build/
 dist/
 .scraps/
 .credentials/
+.vscode/*
+!.vscode/extensions.json
 
 crap.py
-.todo
 NOTE
 scripts/changelog.md
+.env
diff --git a/.todo b/.todo
new file mode 100644
index 0000000..d197d15
--- /dev/null
+++ b/.todo
@@ -0,0 +1,6 @@
+https://www.riverbankcomputing.com/static/Docs/pyqtdeploy/demo.html#android
+Handle VC redistributable
+Fix verbose output for gogo tests
+Remove dub in gogo results
+Remove old versions from registry when updating
+Make version button in about check for updates
\ No newline at end of file
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644
index 0000000..f252ca8
--- /dev/null
+++ b/.vscode/extensions.json
@@ -0,0 +1,10 @@
+{
+    "recommendations": [
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "aaron-bond.better-comments",
+        "tamasfe.even-better-toml",
+        "esbenp.prettier-vscode",
+        "yzhang.markdown-all-in-one",
+    ]
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index 8447c47..cfcd10e 100755
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 A blazingly fast desktop app for batch downloading anime and auto-downloading new episodes upon release
 </p>
 
-<p align="center">
+<p align="center"
  <a href=https://github.com/SenZmaKi/Senpwai/actions/workflows/test.yml> <img height="30px" src=https://github.com/SenZmaKi/Senpwai/actions/workflows/test.yml/badge.svg alt=test-workflow-status-badge></a>
  <a href="https://github.com/SenZmaKi/Senpwai/releases"><img  height="30px" src="https://img.shields.io/github/downloads/SenZmaKi/Senpwai/total" alt="Downloads"></a>
  <a href="https://discord.gg/invite/e9UxkuyDX2" target="_blank"><img height="30px" alt="Discord" src="https://img.shields.io/discord/1131981618777702540?label=Discord&logo=discord" alt="Discord-icon"></a>
@@ -17,7 +17,8 @@ A blazingly fast desktop app for batch downloading anime and auto-downloading ne
   <a href="#building-from-source">Building from source</a> •
   <a href="#support">Support</a> •
   <a href="#faq">FAQ</a> •
-  <a href="#links">Links</a>
+  <a href="#links">Links</a> •
+  <a href="#contribution">Contribution</a>
 </p>
 
 <img align="center" src="https://raw.githubusercontent.com/SenZmaKi/Senpwai/master/.github/images/one-piece.png" alt="one-piece-screenshot">
@@ -145,6 +146,16 @@ More sources means more writing more code which in turn means fixing more bugs.
 
 [Patreon](https://patreon.com/Senpwai)
 
+## Contribution
+
+-   If it's a change to code e.g., `main.py` make the pull request into the most recent branch e.g., `v2.1.5` instead of `master`.
+-   If it's a change to documentation e.g., `README.md` make the pull request into the `master` branch.
+-   If you open the project folder on [Visual Studio Code](https://code.visualstudio.com/) you will be prompted to install recommended extensions for the project.
+-   [Pyright](https://github.com/microsoft/pyright) is used as the type checker, ensure your code is type annotated well and there are no type errors.
+-   [Ruff](https://github.com/astral-sh/ruff) is used for formatting and linting.
+-   [Inno Setup](https://jrsoftware.org/isinfo.php) is used for creating the installer, add the installation folder to the `%PATH%` environment variable for access to `ISCC.exe` from the command line. Also set the `SENPWAI_ROOT_DIR` environment variable to the root directory of the project.
+-   [Poe](https://github.com/nat-n/poethepoet) is used as the task runner, there are various tasks available to run e.g., `poe lint` to lint the code. It autoloads the `.env` file in the root directory of the project. Poe is installed when you setup the project.
+
 ## Legal Disclaimer
 
 Senpwai is designed solely for providing access to publicly available content. It is not intended to support or promote piracy or copyright infringement. As the creator of this app, I hereby declare that I am not responsible for, and in no way associated with, any external links or the content they direct to.
diff --git a/pyproject.toml b/pyproject.toml
index c163dc9..15a03ea 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -63,6 +63,9 @@ poetry-plugin-export = "^1.8.0"
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.poe]
+envfile = ".env"
+
 [tool.poe.tasks]
 release = "python -m scripts.release"
 export_dependencies = "poetry export -f requirements.txt --output requirements.txt"