From d7bea02361535eee92f1a970fb184f0f1d5ffb41 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=BB=9B=E4=BA=BD?=
 <83791825+Soltus@users.noreply.github.com>
Date: Fri, 14 Apr 2023 16:06:15 +0800
Subject: [PATCH] Provide useful information for contributors (#7994)

* Update parse-changelog.py

* Update win-build.bat

* Update win-build.bat

* Update win-build.bat
---
 scripts/parse-changelog.py | 6 +++---
 scripts/win-build.bat      | 8 ++++++++
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/scripts/parse-changelog.py b/scripts/parse-changelog.py
index 0b63c2b9c..3bbe1a3cc 100644
--- a/scripts/parse-changelog.py
+++ b/scripts/parse-changelog.py
@@ -3,8 +3,8 @@ import re
 from argparse import ArgumentParser
 from collections import defaultdict
 
-import github
-
+import github  # pip install PyGithub
+# ensure the milestone is open before run this
 docmap = {
     "Feature": "Feature",
     "Enhancement": "Enhancement",
@@ -35,7 +35,7 @@ def generate_msg_from_repo(repo_name, tag_name, lastestRelease):
     repo = gh.get_repo(repo_name)
     milestone = find_milestone(repo, tag_name, lastestRelease)
 
-    for issue in repo.get_issues(state="closed", milestone=milestone):
+    for issue in repo.get_issues(state="closed", milestone=milestone):  # type: ignore
         # REF https://pygithub.readthedocs.io/en/latest/github_objects/Issue.html#github.Issue.Issue
         desc_mapping[get_issue_first_label(issue)].append(
             {"title": issue.title, "url": issue.html_url}
diff --git a/scripts/win-build.bat b/scripts/win-build.bat
index 91e7e34cf..1563a4052 100644
--- a/scripts/win-build.bat
+++ b/scripts/win-build.bat
@@ -1,3 +1,6 @@
+@echo off
+echo 'use ".\scripts\win-build.bat" instead of "win-build.bat"'
+
 echo 'Building UI'
 cd app
 call pnpm install
@@ -9,16 +12,19 @@ del /S /Q /F app\build 1>nul
 del /S /Q /F app\kernel 1>nul
 
 echo 'Building Kernel'
+@REM the C compiler "gcc" is necessary https://sourceforge.net/projects/mingw-w64/files/mingw-w64/
 go version
 set GO111MODULE=on
 set GOPROXY=https://goproxy.io
 set CGO_ENABLED=1
 
 cd kernel
+@REM you can use `go generate` instead (nead add something in main.go)
 goversioninfo -platform-specific=true -icon=resource/icon.ico -manifest=resource/goversioninfo.exe.manifest
 
 set GOOS=windows
 set GOARCH=amd64
+@REM you can use `go mod tidy` to update kernel dependency bofore build
 go build --tags fts5 -v -o "../app/kernel/SiYuan-Kernel.exe" -ldflags "-s -w -H=windowsgui" .
 
 cd ..
@@ -30,5 +36,7 @@ call pnpm run dist
 cd ..
 
 echo 'Building Appx'
+echo 'Building Appx should be disabled if you do not need it. Not configured correctly will lead to build failures'
 cd . > app\build\win-unpacked\resources\ms-store
 electron-windows-store --input-directory app\build\win-unpacked --output-directory app\build\ --package-version 1.0.0.0 --package-name SiYuan --manifest app\appx\AppxManifest.xml --assets app\appx\assets\ --make-pri true
+