david_bai
54 lines
3.3 KiB
Markdown
54 lines
3.3 KiB
Markdown
# 感谢你对 PrivyDrop 的兴趣和贡献！
|
|
|
|
我们非常欢迎社区的贡献。你的每一份努力都将使这个项目变得更好。在开始之前，请花几分钟时间阅读以下指南。
|
|
|
|
## 从哪里开始？看路线图！
|
|
|
|
在开始之前，一个绝佳的起点是我们的项目路线图。它概述了我们的未来计划和当前的工作重点，能让你清晰地了解项目的走向，以及在哪些方面最需要你的帮助。
|
|
|
|
➡️ **[查看我们的项目路线图](../ROADMAP.zh-CN.md)**
|
|
|
|
在查阅路线图之后，你可以在 [GitHub Issues](https://github.com/david-bai00/PrivyDrop/issues) 中寻找合适的任务，特别是那些被标记为 `help wanted` 或 `good first issue` 的任务。
|
|
|
|
## 行为准则
|
|
|
|
我们致力于为所有成员提供一个友好、安全和热情的环境。请确保你的行为符合我们的 [**行为准则**](./CODE_OF_CONDUCT.zh-CN.md)。我们期望所有参与者都能遵守该准则。
|
|
|
|
## 如何贡献
|
|
|
|
### 报告 Bug
|
|
|
|
如果你在使用的过程中发现了 Bug，请通过 [GitHub Issues](https://github.com/david-bai00/PrivyDrop/issues) 提交。为了让我们能更快地定位和修复问题，请在提交时尽量提供以下信息：
|
|
|
|
- **清晰的标题和描述**: 简要概括问题。
|
|
- **复现步骤**: 详细说明如何一步步地复现这个 Bug。
|
|
- **期望的行为**: 描述在没有 Bug 的情况下，程序应该如何表现。
|
|
- **实际的行为**: 描述程序实际发生了什么。
|
|
- **截图或录屏**: 如果可能，请附上截图或录屏来直观地展示问题。
|
|
- **环境信息**: 你使用的操作系统、浏览器版本等。
|
|
|
|
### 提出功能建议
|
|
|
|
如果你有关于新功能或改进现有功能的想法，也欢迎通过 [GitHub Issues](https://github.com/david-bai00/PrivyDrop/issues) 提出。请详细描述你建议的功能、它能解决什么问题，以及它可能的使用场景。
|
|
|
|
### 提交代码 (Pull Request)
|
|
|
|
我们非常欢迎你通过 Pull Request (PR) 为项目贡献代码。
|
|
|
|
1. **Fork 仓库**: 点击项目主页右上角的 "Fork" 按钮，将主仓库 Fork 到你自己的账户下。
|
|
2. **Clone 你的 Fork**: `git clone https://github.com/david-bai00/PrivyDrop.git`
|
|
3. **创建分支**: 从 `main` (或 `develop`) 分支创建一个新的特性分支。请为你的分支起一个有描述性的名字（例如 `feature/add-dark-mode` 或 `fix/login-bug`）。
|
|
```bash
|
|
git checkout -b feature/your-new-feature
|
|
```
|
|
4. **进行修改**: 编写你的代码。请确保遵循项目现有的代码风格。
|
|
5. **提交更改**: `git commit -m "feat: Add some amazing feature"` (我们推荐使用 [Conventional Commits](https://www.conventionalcommits.org/) 规范)
|
|
6. **Push 到你的 Fork**: `git push origin feature/your-new-feature`
|
|
7. **创建 Pull Request**: 回到你的 GitHub Fork 页面，点击 "New pull request" 按钮，创建一个指向主仓库的 PR。请在 PR 描述中清晰地说明你做了什么、解决了什么问题。
|
|
|
|
## 代码风格
|
|
|
|
- 请遵循项目现有的代码风格。
|
|
- 我们使用 ESLint 和 Prettier 来保证代码风格的一致性。在提交代码前，请确保你的代码通过了检查。
|
|
|
|
再次感谢你的贡献！ 您提交的任何贡献都将被视为在 MIT 许可下授权。 |