Skip to content

Commit c14da54

Browse files
HEFIVE1102HEFIVE1102
committed
chore: add GitHub repo infrastructure
- CI workflow (Node + Rust checks) - Issue templates (bug report + feature request) - Contributing guide - Code of Conduct - Updated README with badges, download, dev setup
1 parent eadecf6 commit c14da54

6 files changed

Lines changed: 169 additions & 6 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report
4+
labels: bug
5+
body:
6+
- type: textarea
7+
id: what-happened
8+
attributes:
9+
label: Describe the bug
10+
description: A clear description of what the bug is.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: reproduce
15+
attributes:
16+
label: To Reproduce
17+
description: Steps to reproduce the behavior.
18+
placeholder: |
19+
1. Open file '...'
20+
2. Click on '...'
21+
3. See error
22+
- type: textarea
23+
id: expected
24+
attributes:
25+
label: Expected behavior
26+
description: What you expected to happen.
27+
- type: textarea
28+
id: screenshots
29+
attributes:
30+
label: Screenshots
31+
description: If applicable, add screenshots.
32+
- type: dropdown
33+
id: os
34+
attributes:
35+
label: OS
36+
options:
37+
- Windows 11
38+
- Windows 10
39+
- macOS
40+
- Linux

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea
4+
labels: enhancement
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Is your feature request related to a problem?
10+
description: A clear description of what the problem is.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: solution
15+
attributes:
16+
label: Describe the solution you'd like
17+
description: What you want to happen.
18+
- type: textarea
19+
id: context
20+
attributes:
21+
label: Additional context
22+
description: Add any other context or screenshots.

‎.github/workflows/ci.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
jobs:
10+
check:
11+
runs-on: windows-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version: 20
18+
cache: npm
19+
20+
- run: npm ci
21+
- run: npm run build
22+
23+
- uses: dtolnay/rust-toolchain@stable
24+
- run: cargo check --manifest-path src-tauri/Cargo.toml

‎CODE_OF_CONDUCT.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We pledge to make participation in our project a harassment-free experience for everyone.
6+
7+
## Our Standards
8+
9+
- Be respectful and inclusive
10+
- Accept constructive criticism gracefully
11+
- Focus on what is best for the community
12+
13+
## Enforcement
14+
15+
Instances of abusive behavior may be reported to the project maintainers.

‎CONTRIBUTING.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to MD Reader
2+
3+
Welcome and thank you for considering contributing to MD Reader!
4+
5+
## How to Contribute
6+
7+
1. Fork the repository
8+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
9+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
10+
4. Push to the branch (`git push origin feature/AmazingFeature`)
11+
5. Open a Pull Request
12+
13+
## Development Setup
14+
15+
```bash
16+
# Clone
17+
git clone https://github.com/HEFIVE1102/md-reader.git
18+
cd md-reader
19+
20+
# Install dependencies
21+
npm install
22+
23+
# Run development mode
24+
npm run tauri dev
25+
26+
# Build
27+
npm run tauri build
28+
```
29+
30+
## Code Style
31+
32+
- TypeScript: follow the existing tsconfig settings
33+
- Rust: `cargo fmt` before committing
34+
- Commit messages: conventional commits (`feat:`, `fix:`, `docs:`, `refactor:`)
35+
36+
## Reporting Bugs
37+
38+
Use the [bug report template](https://github.com/HEFIVE1102/md-reader/issues/new?template=bug_report.yml).
39+
40+
## Feature Requests
41+
42+
Use the [feature request template](https://github.com/HEFIVE1102/md-reader/issues/new?template=feature_request.yml).

‎README.md‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A desktop Markdown reader built with Tauri v2 + TypeScript.
55
## Features
66

77
- Open and render Markdown files (`.md`, `.markdown`, `.mdown`)
8-
- Syntax highlighting for code blocks
8+
- Syntax highlighting for code blocks (highlight.js)
99
- KaTeX math rendering
1010
- Mermaid diagram support
1111
- Task lists
@@ -18,19 +18,39 @@ A desktop Markdown reader built with Tauri v2 + TypeScript.
1818
- **Backend:** Tauri v2 (Rust)
1919
- **Rendering:** highlight.js, KaTeX, Mermaid
2020

21+
## Download
22+
23+
Releases will be available on the [Releases page](https://github.com/HEFIVE1102/md-reader/releases).
24+
2125
## Development
2226

27+
### Prerequisites
28+
29+
- [Node.js](https://nodejs.org/) (v20+)
30+
- [Rust](https://www.rust-lang.org/tools/install) (latest stable)
31+
- [Tauri CLI](https://v2.tauri.app/start/prerequisites/)
32+
33+
### Setup
34+
2335
```bash
36+
# Clone
37+
git clone https://github.com/HEFIVE1102/md-reader.git
38+
cd md-reader
39+
40+
# Install dependencies
2441
npm install
25-
npm run tauri dev
26-
```
2742

28-
## Build
43+
# Run development mode
44+
npm run tauri dev
2945

30-
```bash
46+
# Build for production
3147
npm run tauri build
3248
```
3349

50+
## Contributing
51+
52+
See [CONTRIBUTING.md](CONTRIBUTING.md).
53+
3454
## License
3555

36-
MIT
56+
[MIT](LICENSE)

0 commit comments

Comments
 (0)