mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-12 02:20:36 +08:00
a6dd8033ed
- 新建 docs-site/ Docusaurus 项目，支持 en + zh-Hans 双语 - 从 README 迁移内容为独立文档页面： - Getting Started（安装、快速开始） - Deployment（Docker、裸机、Nginx、配置参考） - Features（备份类型、存储后端、SAP HANA、多节点集群、通知） - Reference（API、CLI） - Development（开发、贡献） - 自定义 BackupX 主题色、logo、落地页组件 - 新增 .github/workflows/docs.yml，Actions 自动构建并发布到 GitHub Pages - README.md 切换为英文，中文版挪到 README.zh-CN.md，两者均精简为导航型 - 配置站点 URL：https://awuqing.github.io/BackupX/
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
title: Contributing
|
|
description: How to report issues, propose changes, and submit PRs.
|
|
---
|
|
|
|
# Contributing
|
|
|
|
BackupX is open-source under Apache License 2.0. Issues and pull requests are welcome.
|
|
|
|
## Reporting bugs
|
|
|
|
Open an issue at [github.com/Awuqing/BackupX/issues](https://github.com/Awuqing/BackupX/issues). Please include:
|
|
|
|
- BackupX version (`backupx --version`)
|
|
- Your deployment mode (Docker / bare metal / from source)
|
|
- Relevant backup task type and storage backend
|
|
- Steps to reproduce
|
|
- Stdout / `backupx.log` excerpt for the window around the problem
|
|
|
|
## Proposing changes
|
|
|
|
For significant features or refactors, open an issue first to align on scope before investing in a PR.
|
|
|
|
## Pull requests
|
|
|
|
1. Fork and create a topic branch (e.g. `fix/windows-path-escape`)
|
|
2. Run `make test` and make sure everything passes
|
|
3. Keep changes focused — one concern per PR
|
|
4. Write commit messages in Chinese following `类型: 简要描述` — examples:
|
|
- `功能: 新增审计日志模块`
|
|
- `修复: 目录浏览器无法进入子目录`
|
|
- `重构: 简化存储目标解密逻辑`
|
|
- Types: `功能` / `修复` / `重构` / `文档` / `构建` / `测试`
|
|
5. PR title and body in Chinese too. Describe the why and how, not just the what.
|
|
|
|
## Coding guidelines
|
|
|
|
- **Go** — handle every error (no `_ = err`); use the existing logger (`zap`); no `fmt.Println` in production paths
|
|
- **TypeScript** — strict mode, no implicit any, follow existing ESLint/Prettier configs
|
|
- **Commit scope** — one logical change per commit; don't mix drive-by cleanups with feature work
|