Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs, unused templates, makefile #108

Merged
merged 3 commits into from
Oct 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE/merge_to_master_template.md

This file was deleted.

1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ Please go the the `Preview` tab and select the appropriate sub-template:
- [Bug Fix](?expand=1&template=bug_fix_template.md): Bug Fixes only
- [Documentation](?expand=1&template=doc_change_template.md): Change documentation
- [General](?expand=1&template=general_template.md): Use this if you cannot find suitable template
- [Merge to master](?expand=1&template=merge_to_master_template.md): Use this only for merge to master

If changes have multiple usage, e.g. `Bug Fix` & `Documentation` at same time, consider mix related template together by yourself.
21 changes: 0 additions & 21 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,25 +35,4 @@ The git branch management should be followed below principle:
3. File changes in each commit should be as few as possible. This is to prevent `rebase` difficulty.
- i.e. if you change `module1` & `module2`, you should not use one commit ONLY to conclude both changes, instead use >2 commits depend on complexity of these changes.

### Suggestion for commit

**_The below guidelines is for suggestion ONLY_**.

For source code changes, always include changes & `changed module`.

`Changed Module` usually represent scope of changes, Here is some example:

- `comicinfo`
- `app.go`
- `makefile`
- `vscode`
- `frontend/input`
- `frontend/App`

Developer can ignore above format when **Necessary**, e.g.

- `Update DEVELOPMENT.md`
- `Update dependencies for ...`
- `Move package ... to ...`

_Last updated: 2024-08-03_
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ binding: ## Generate wails binding
.PHONY: clean
clean: ## Remove distribution of both frontend and backend
cd frontend; rm -rf dist
rm build/bin/*.exe
rm -f build/bin/*.exe

.PHONY: dist
dist: ## Create a wails executeable distribution
rm build/bin/*.*
rm -f build/bin/*.*
wails build
@CURRENT_TAG=$$(git tag --points-at);\
CURRENT_TAG=$$(echo "$${CURRENT_TAG////-}");\
Expand Down
8 changes: 4 additions & 4 deletions internal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ Package for wails app.

The package to convert image directory to `.zip` and `.cbz` file.

## assets

Package to control database & schema, and some fixed environment constants.

## comicinfo

The [ComicInfo.xml](https://anansi-project.github.io/docs/comicinfo/documentation) Structure in `Go`, Converted from `ComicInfo.xsd`.

Current Schema version is `2.1`.

## database

The package to manipulate the database. Current `user_version` is `1`.

## files

The package contains multiple utility function for files system.
Expand Down