Skip to content

Commit 4f7396a

Browse files
committed
Fix markdown linting issues and add CI check
1 parent cd211bc commit 4f7396a

19 files changed

Lines changed: 197 additions & 158 deletions

File tree

.github/workflows/pr-check-tests.yml

Lines changed: 5 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ jobs:
1313
- name: Checkout Code
1414
uses: actions/checkout@v3
1515

16+
- name: Markdown lint
17+
uses: DavidAnson/markdownlint-cli2-action@v23
18+
1619
- name: Set up Node.js
1720
uses: actions/setup-node@v3
1821
with:
@@ -26,6 +29,7 @@ jobs:
2629
cd backend
2730
pip install pre-commit ruff black
2831
cd ..
32+
2933
- name: Run Linters
3034
run: |
3135
cd frontend/
@@ -36,55 +40,4 @@ jobs:
3640
pre-commit run --config ../.pre-commit-config.yaml --all-files || exit 1
3741
cd ..
3842
cd frontend/src-tauri/
39-
cargo fmt -- --check
40-
41-
# Frontend Test Job
42-
frontend:
43-
runs-on: ubuntu-latest
44-
name: Frontend Tests
45-
steps:
46-
- name: Checkout Code
47-
uses: actions/checkout@v3
48-
49-
- name: Set up Node.js
50-
uses: actions/setup-node@v3
51-
with:
52-
node-version: "18"
53-
54-
- name: Install Dependencies & Run Tests
55-
run: |
56-
cd frontend
57-
npm install
58-
npm test
59-
60-
# Backend Test Job
61-
backend:
62-
runs-on: ubuntu-latest
63-
name: Backend Tests
64-
steps:
65-
- name: Checkout Code
66-
uses: actions/checkout@v3
67-
68-
- name: Set up Python
69-
uses: actions/setup-python@v4
70-
with:
71-
python-version: "3.11"
72-
73-
- name: Build check(Main backend)
74-
run: |
75-
cd backend
76-
python -m pip install --upgrade pip
77-
pip install -r requirements.txt
78-
pyinstaller main.py --name PictoPy_Server --onedir --distpath dist
79-
80-
- name: Build check(Sync Microservice)
81-
run: |
82-
cd sync-microservice
83-
pip install -r requirements.txt
84-
pyinstaller main.py --name PictoPy_Sync_Microservice --onedir --distpath dist
85-
86-
- name: Run Tests
87-
run: |
88-
cd backend
89-
pytest
90-
43+
cargo fmt -- --check

.markdownlint-cli2.jsonc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"config": {
3+
"MD013": false,
4+
"MD024": {
5+
"siblings_only": true
6+
}
7+
},
8+
"globs": [
9+
"**/*.md",
10+
"!**/node_modules/**",
11+
"!**/target/**",
12+
"!**/venv/**",
13+
"!**/.venv/**",
14+
"!LICENSE.md"
15+
]
16+
}

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
aossie.oss@gmail.com.
63+
<aossie.oss@gmail.com>.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120120

121121
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122122
enforcement ladder](https://github.com/mozilla/diversity).
123123

124124
[homepage]: https://www.contributor-covenant.org
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Hi there! Thank you for considering contributing to **PictoPy** – we’re exci
44

55
NOTE: Please do not open a PR for the issue which is not yet reviewed and labelled by the maintainer. Wait for the maintainer to give a green light.
66

7-
# Setting Up the Project
7+
## Setting Up the Project
88

99
## Setup
1010

@@ -20,40 +20,40 @@ To set up and run the docs website on your local machine:
2020
1. Ensure you have **Python 3** and **pip** installed. Navigate to the `/docs` folder.
2121
2. Create a virtual environment:
2222

23-
```bash
24-
python -m venv .docs-env
25-
```
23+
```bash
24+
python -m venv .docs-env
25+
```
2626

2727
3. Activate the virtual environment:
2828

29-
```bash
30-
# On macOS/Linux:
31-
source .docs-env/bin/activate
32-
# On Windows:
33-
.docs-env\Scripts\activate
34-
```
29+
```bash
30+
# On macOS/Linux:
31+
source .docs-env/bin/activate
32+
# On Windows:
33+
.docs-env\Scripts\activate
34+
```
3535

3636
4. Install the required Python packages:
3737

38-
```bash
39-
pip install -r requirements.txt
40-
```
38+
```bash
39+
pip install -r requirements.txt
40+
```
4141

4242
5. Start the local MkDocs server:
4343

44-
```bash
45-
mkdocs serve -f ../mkdocs.yml
46-
```
44+
```bash
45+
mkdocs serve -f ../mkdocs.yml
46+
```
4747

48-
6. Open your browser and navigate to: http://127.0.0.1:8000.
48+
6. Open your browser and navigate to: <http://127.0.0.1:8000>.
4949

5050
7. Edit Markdown files inside the `docs/` folder. The site will automatically reload when changes are saved.
5151

5252
8. To build the static site for production deployment, run:
5353

54-
```bash
55-
mkdocs build -f ../mkdocs.yml
56-
```
54+
```bash
55+
mkdocs build -f ../mkdocs.yml
56+
```
5757

5858
## Testing
5959

@@ -67,10 +67,12 @@ npm test
6767
### Backend
6868

6969
- FastAPI
70+
7071
```bash
7172
cd backend
7273
pytest
7374
```
75+
7476
- Tauri
7577

7678
```bash

COPYRIGHT.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
Copyright © 2026 AOSSIE <br />
1+
# Copyright Notice
2+
3+
Copyright © 2026 AOSSIE
24
All rights reserved.
35

4-
All works in this repository may be used according to the conditions
6+
All works in this repository may be used according to the conditions
57
stated in the LICENSE.md file available in this repository.
68

79
These works are WITHOUT ANY WARRANTY, without even the implied warranty of

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD033 MD041 -->
12
<!-- Don't delete it -->
23
<div name="readme-top"></div>
34

@@ -42,16 +43,19 @@ Find out more at [https://pictopy.aossie.org/](https://pictopy.aossie.org/).
4243

4344
## Features
4445

45-
**AI-powered**
46+
### AI-powered
47+
4648
* Smart tagging based on detected faces and objects
4749
* Advanced image analysis with object detection and facial recognition
4850
* Smart search and retrieval
4951

50-
**Gallery management**
52+
### Gallery management
53+
5154
* Album management with traditional gallery features
5255
* Cross-platform compatibility
5356

54-
**Privacy & performance**
57+
### Privacy & performance
58+
5559
* Privacy-focused design with fully offline functionality
5660
* Efficient data handling and parallel processing
5761

@@ -94,7 +98,7 @@ Find out more at [https://pictopy.aossie.org/](https://pictopy.aossie.org/).
9498

9599
## Want to Contribute?
96100

97-
<a href="https://discord.gg/hjUhu33uAn"><img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" height="30"></a>
101+
<a href="https://discord.gg/hjUhu33uAn"><img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" alt="Discord" height="30"></a>
98102

99103
1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
100104
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
@@ -103,7 +107,6 @@ Don't forget to star this repository if you find it useful! ⭐
103107

104108
Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
105109

106-
107110
## License
108111

109112
This project is licensed under the GNU General Public License v3.0.
@@ -115,4 +118,4 @@ Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂
115118

116119
[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/PictoPy)](https://github.com/AOSSIE-Org/PictoPy/graphs/contributors)
117120

118-
© 2026 AOSSIE
121+
© 2026 AOSSIE

backend/dist/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
## Do not delete the "dist" folder.
1+
# Do not delete the "dist" folder
22

33
This folder is essential for the development environment to start.

0 commit comments

Comments
 (0)