diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..98cd09a --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `david.vision66@gmail.com`. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interaction in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.zh-CN.md b/.github/CODE_OF_CONDUCT.zh-CN.md new file mode 100644 index 0000000..2c44b2d --- /dev/null +++ b/.github/CODE_OF_CONDUCT.zh-CN.md @@ -0,0 +1,76 @@ +# 贡献者契约行为准则 + +## 我们的承诺 + +作为成员、贡献者和领导者，我们承诺让社区参与者免受骚扰，无论其年龄、体型、可见或不可见的残疾、族裔、性别特征、性别认同和表达、经验水平、教育程度、社会经济地位、国籍、个人形象、种族、宗教或性认同和性取向如何。 + +我们承诺以有助于建立一个开放、热情、多样化、包容和健康的社区的方式行事和互动。 + +## 我们的标准 + +有助于为我们社区创造积极环境的行为示例包括： + +* 对他人的遭遇表现出同情和善意 +* 尊重不同的意见、观点和经历 +* 优雅地给予和接受建设性的反馈 +* 承担责任，向因我们的错误而受到影响的人道歉，并从中吸取教训 +* 关注的不仅是我们个人的最佳利益，也应着眼于整个社区的最佳利益 + +不可接受的行为示例包括： + +* 使用色情化语言或图像，以及任何形式的性引诱或挑逗 +* 引战、侮辱性或贬损性评论，以及人身或政治攻击 +* 公开或私下的骚扰 +* 未经他人明确许可，发布其私人信息，例如住址或电子邮箱 +* 在专业场合可以被合理地认为是不当的其他行为 + +## 执行责任 + +社区领导者有责任澄清和执行我们的标准，并将对任何他们认为不当、具有威胁性、冒犯性或有害的行为采取适当和公平的纠正措施。 + +社区领导者有权利和责任删除、编辑或拒绝与本行为准则不符的评论、提交、代码、维基编辑、问题和其他贡献，并在适当时沟通审核决定。 + +## 范围 + +本行为准则适用于所有社区空间，也适用于个人在公共场合正式代表社区的情况。代表我们社区的例子包括使用官方电子邮件地址、通过官方社交媒体帐户发帖，或作为指定代表参加线上或线下活动。 + +## 执行 + +可以通过 `david.vision66@gmail.com` 联系负责执行的社区领导者，报告辱骂、骚扰或其他不可接受的行为。所有投诉都将得到迅速和公平的审查和调查。 + +所有社区领导者都有义务尊重任何事件报告者的隐私和安全。 + +## 执行指南 + +社区领导者将遵循以下社区影响指南，来确定他们认为违反本行为准则的任何行为的后果： + +### 1. 纠正 + +**社区影响**: 使用不当语言或社区中其他被认为不专业或不受欢迎的行为。 + +**后果**: 社区领导者发出私下书面警告，明确说明违规行为的性质，并解释为什么该行为不当。可能会要求公开道歉。 + +### 2. 警告 + +**社区影响**: 单次事件或一系列行为造成的违规。 + +**后果**: 带有持续行为后果的警告。在指定时间内，禁止与相关人员互动，包括主动与执行行为准则的人员互动。这包括避免在社区空间以及社交媒体等外部渠道进行互动。违反这些条款可能导致临时或永久禁令。 + +### 3. 临时封禁 + +**社区影响**: 严重违反社区标准，包括持续的不当行为。 + +**后果**: 在指定时间内，临时禁止与社区进行任何形式的互动或公开交流。在此期间，不得与相关人员进行公开或私下的互动，包括主动与执行行为准则的人员互动。违反这些条款可能导致永久禁令。 + +### 4. 永久封禁 + +**社区影响**: 表现出违反社区标准的行为模式，包括持续的不当行为、骚扰个人，或对某些类别的个人进行攻击或贬低。 + +**后果**: 永久禁止在社区内进行任何形式的公开互动。 + +## 来源 + +本行为准则改编自 [Contributor Covenant][homepage] 2.1 版本, 可在 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1] 查看。 + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 309ed0a..580569c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,46 +1,46 @@ -# 感谢你对 PrivyDrop 的兴趣和贡献！ +# Thank you for your interest and contribution to PrivyDrop! -我们非常欢迎社区的贡献。你的每一份努力都将使这个项目变得更好。在开始之前，请花几分钟时间阅读以下指南。 +We warmly welcome contributions from the community. Every bit of your effort helps make this project better. Before you start, please take a few moments to read the following guidelines. -## 行为准则 +## Code of Conduct -我们致力于为所有成员提供一个友好、安全和热情的环境。请确保你的行为符合我们的行为准则（未来可添加 Code of Conduct）。 +We are committed to providing a friendly, safe, and welcoming environment for all. Please ensure your conduct aligns with our [Code of Conduct](./.github/CODE_OF_CONDUCT.md). All participants are expected to uphold this code. -## 如何贡献 +## How to Contribute -### 报告 Bug +### Reporting Bugs -如果你在使用的过程中发现了 Bug，请通过 [GitHub Issues](https://github.com/yourusername/privydrop/issues) 提交。为了让我们能更快地定位和修复问题，请在提交时尽量提供以下信息： +If you find a bug while using the application, please submit it via [GitHub Issues](https://github.com/david-bai00/PrivyDrop/issues). To help us locate and fix the problem faster, please provide the following information when submitting: -- **清晰的标题和描述**: 简要概括问题。 -- **复现步骤**: 详细说明如何一步步地复现这个 Bug。 -- **期望的行为**: 描述在没有 Bug 的情况下，程序应该如何表现。 -- **实际的行为**: 描述程序实际发生了什么。 -- **截图或录屏**: 如果可能，请附上截图或录屏来直观地展示问题。 -- **环境信息**: 你使用的操作系统、浏览器版本等。 +- **Clear Title and Description**: Briefly summarize the issue. +- **Steps to Reproduce**: Detail how to reproduce the bug step-by-step. +- **Expected Behavior**: Describe what should happen without the bug. +- **Actual Behavior**: Describe what actually happened. +- **Screenshots or Screencasts**: If possible, attach screenshots or a screen recording to visually demonstrate the issue. +- **Environment Information**: Your operating system, browser version, etc. -### 提出功能建议 +### Suggesting Enhancements -如果你有关于新功能或改进现有功能的想法，也欢迎通过 [GitHub Issues](https://github.com/yourusername/privydrop/issues) 提出。请详细描述你建议的功能、它能解决什么问题，以及它可能的使用场景。 +If you have an idea for a new feature or an improvement to an existing one, you are welcome to propose it via [GitHub Issues](https://github.com/david-bai00/PrivyDrop/issues). Please describe the feature you're suggesting, the problem it solves, and its potential use cases in detail. -### 提交代码 (Pull Request) +### Submitting Pull Requests -我们非常欢迎你通过 Pull Request (PR) 为项目贡献代码。 +We gladly accept code contributions through Pull Requests (PRs). -1. **Fork 仓库**: 点击项目主页右上角的 "Fork" 按钮，将主仓库 Fork 到你自己的账户下。 -2. **Clone 你的 Fork**: `git clone https://github.com/your-username/privydrop.git` -3. **创建分支**: 从 `main` (或 `develop`) 分支创建一个新的特性分支。请为你的分支起一个有描述性的名字（例如 `feature/add-dark-mode` 或 `fix/login-bug`）。 +1. **Fork the Repository**: Click the "Fork" button in the top-right corner of the project's homepage to fork the main repository to your own account. +2. **Clone Your Fork**: `git clone https://github.com/YOUR_USERNAME/PrivyDrop.git` +3. **Create a Branch**: Create a new feature branch from the `main` (or `develop`) branch. Please give your branch a descriptive name (e.g., `feature/add-dark-mode` or `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 描述中清晰地说明你做了什么、解决了什么问题。 +4. **Make Changes**: Write your code. Please ensure you follow the existing code style of the project. +5. **Commit Changes**: `git commit -m "feat: Add some amazing feature"` (We recommend using the [Conventional Commits](https://www.conventionalcommits.org/) specification). +6. **Push to Your Fork**: `git push origin feature/your-new-feature` +7. **Create a Pull Request**: Go to your GitHub fork page, click the "New pull request" button, and create a PR targeting the main repository. Please clearly explain what you did and what problem you solved in the PR description. -## 代码风格 +## Coding Style -- 请遵循项目现有的代码风格。 -- 我们使用 ESLint 和 Prettier 来保证代码风格的一致性。在提交代码前，请确保你的代码通过了检查。 +- Please follow the existing coding style of the project. +- We use ESLint and Prettier to ensure consistent code style. Before submitting your code, please make sure it passes all checks. -再次感谢你的贡献！ 您提交的任何贡献都将被视为在 MIT 许可下授权。 \ No newline at end of file +Thank you again for your contribution! Any contribution you make will be licensed under the MIT License. \ No newline at end of file diff --git a/.github/CONTRIBUTING.zh-CN.md b/.github/CONTRIBUTING.zh-CN.md new file mode 100644 index 0000000..6994dd5 --- /dev/null +++ b/.github/CONTRIBUTING.zh-CN.md @@ -0,0 +1,46 @@ +# 感谢你对 PrivyDrop 的兴趣和贡献！ + +我们非常欢迎社区的贡献。你的每一份努力都将使这个项目变得更好。在开始之前，请花几分钟时间阅读以下指南。 + +## 行为准则 + +我们致力于为所有成员提供一个友好、安全和热情的环境。请确保你的行为符合我们的 [**行为准则**](./.github/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 许可下授权。 \ No newline at end of file diff --git a/README.md b/README.md index 997e142..761500d 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,9 @@ We provide detailed documentation to help you dive deeper into the project's des We warmly welcome contributions of all forms! Whether it's reporting a bug, suggesting a feature, submitting code or adding a star, your help is invaluable to PrivyDrop's growth. Please read our [**Contribution Guidelines**](./.github/CONTRIBUTING.md) to start your journey. +We have a [**Code of Conduct**](./.github/CODE_OF_CONDUCT.md) that all contributors are expected to follow. Please be sure to review it before participating. + + ## 📄 License This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details. diff --git a/README.zh-CN.md b/README.zh-CN.md index 6122ee4..d9d9bd2 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -77,7 +77,9 @@ PrivyDrop (原 SecureShare) 是一个基于 WebRTC 的开源点对点（P2P） ## 🤝 参与贡献 -我们热烈欢迎任何形式的贡献！无论是报告 Bug、提出功能建议、提交代码还是加星，都对 PrivyDrop 的成长帮助巨大。请阅读我们的 [**贡献指南**](./.github/CONTRIBUTING.md) 来开始你的贡献之旅。 +我们热烈欢迎任何形式的贡献！无论是报告 Bug、提出功能建议、提交代码还是加星，都对 PrivyDrop 的成长帮助巨大。请阅读我们的 [**贡献指南**](./.github/CONTRIBUTING.zh-CN.md) 来开始你的贡献之旅。 + +我们制定了所有贡献者都应遵守的 [**行为准则**](./.github/CODE_OF_CONDUCT.zh-CN.md)，请在参与前仔细阅读。 ## 📄 开源协议 diff --git a/frontend/README.zh-CN.md b/frontend/README.zh-CN.md index dbd3be4..57c0342 100644 --- a/frontend/README.zh-CN.md +++ b/frontend/README.zh-CN.md @@ -43,4 +43,4 @@ ## 🤝 参与贡献 -我们欢迎任何形式的贡献！请阅读根目录下的 [**贡献指南**](../.github/CONTRIBUTING.md) 来开始。 +我们欢迎任何形式的贡献！请阅读根目录下的 [**贡献指南**](../.github/CONTRIBUTING.zh-CN.md) 来开始。