Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](/CODE_OF_CONDUCT.md) | [![zh](https://img.shields.io/badge/lang-zh--CN-yellow.svg)](/CODE_OF_CONDUCT.zh.md)

# Contributor Covenant Code of Conduct

## Our Pledge
Expand Down
48 changes: 48 additions & 0 deletions CODE_OF_CONDUCT.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](/CODE_OF_CONDUCT.md) | [![zh](https://img.shields.io/badge/lang-zh--CN-yellow.svg)](/CODE_OF_CONDUCT.zh.md)

# 贡献者公约 行为准则

## 我们的承诺

为了营造一个开放和友好的环境,我们作为贡献者和维护者承诺,无论年龄、体型、残疾、种族、性别认同和表达、经验水平、国籍、个人外貌、种族、宗教或性取向如何,使每个人在参与我们的项目和社区时都能获得无骚扰的体验。

## 我们的标准

有助于创造积极环境的行为示例包括:

* 使用欢迎和包容的语言
* 尊重不同的观点和经验
* 优雅地接受建设性批评
* 关注对社区最有利的事情
* 对其他社区成员表示同理心

参与者不可接受的行为示例包括:

* 使用性暗示的语言或图像以及不受欢迎的性关注或挑逗
* 恶意评论、侮辱/贬低性评论以及人身或政治攻击
* 公开或私下骚扰
* 未经明确许可发布他人的私人信息,如物理地址或电子地址
* 其他在专业环境中可能被合理认为不适当的行为

## 我们的责任

项目维护者负责明确可接受行为的标准,并期望在出现任何不可接受行为时采取适当和公正的纠正措施。

项目维护者有权和责任删除、编辑或拒绝与本行为准则不符的评论、提交、代码、wiki编辑、问题以及其他贡献,或暂时或永久禁止任何贡献者从事他们认为不适当、威胁性、冒犯性或有害的其他行为。

## 范围

本行为准则既适用于项目空间内,也适用于个人代表项目或其社区时的公共空间。代表项目或社区的示例包括使用官方项目电子邮件地址、通过官方社交媒体账户发帖,或作为指定代表参与线上或线下活动。项目代表的具体定义和说明由项目维护者进一步确定。

## 执行

如有虐待、骚扰或其他不可接受的行为,请通过联系项目团队 erik@bjareho.lt 进行举报。项目团队将审查和调查所有投诉,并以适当的方式回应。项目团队有义务对事件举报人保密。具体执行政策的更多细节可能会单独发布。

未真诚遵守或执行行为准则的项目维护者可能会面临项目领导层其他成员决定的临时或永久性处罚。

## 归属

本行为准则改编自[贡献者公约][homepage] 1.4 版,可在 http://contributor-covenant.org/version/1/4 获取。

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](/CONTRIBUTING.md) | [![zh](https://img.shields.io/badge/lang-zh--CN-yellow.svg)](/CONTRIBUTING.zh.md)

How to Contribute
=================

Expand Down
118 changes: 118 additions & 0 deletions CONTRIBUTING.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](/CONTRIBUTING.md) | [![zh](https://img.shields.io/badge/lang-zh--CN-yellow.svg)](/CONTRIBUTING.zh.md)

如何贡献
============

<!-- 本指南可根据 https://mozillascience.github.io/working-open-workshop/contributing/ 的建议进行改进 -->

**目录**

- [开始](#开始)
- [你可以如何帮助](#你可以如何帮助)
- [提交 Issue](#提交-issue)
- [行为准则](#行为准则)
- [提交消息规范](#提交消息规范)
- [获得报酬](#获得报酬)
- [领取 GitPOAP](#领取-gitpoap)
- [问题?](#问题)

## 开始

要开发 ActivityWatch,你首先需要从源代码安装。请按照[文档中的指南](https://activitywatch.readthedocs.io/en/latest/installing-from-source.html)进行操作。

你可能还想了解[架构](https://activitywatch.readthedocs.io/en/latest/architecture.html)和[数据模型](https://activitywatch.readthedocs.io/en/latest/buckets-and-events.html)。

如果你想要一些如何编写监控器或其他类型客户端的代码示例,请参阅[编写监控器的文档](https://docs.activitywatch.net/en/latest/examples/writing-watchers.html)。

## 你可以如何帮助

有很多方式可以为 ActivityWatch 做出贡献:

- 处理标记为 [`good first issue`][good first issue] 或 [`help wanted`][help wanted] 的问题,这些特别适合新贡献者
- 修复 [`bug`][bugs]
- 实现新功能
- 在论坛上查看[请求的功能][requested features]
- 在 issue 中或通过[我们的 Discord 服务器][discord]与我们交流,获取如何进行的帮助
- 编写[文档](https://github.com/ActivityWatch/docs)
- 构建生态系统
- 例如:新的监控器、数据分析工具、从其他源导入数据的工具等

如果你对我们下一步的计划感兴趣,请查看我们的[路线图][roadmap]和[里程碑][milestones]。

以上大部分工作都能让你登上我们的[贡献者统计页面][contributors]作为感谢!

[good first issue]: https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[help wanted]: https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
[bugs]: https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22
[milestones]: https://github.com/ActivityWatch/activitywatch/milestones
[roadmap]: https://github.com/orgs/ActivityWatch/projects/2
[requested features]: https://forum.activitywatch.net/c/features
[contributors]: http://activitywatch.net/contributors/

## 提交 Issue

感谢你希望通过提交 Issue 来帮助我们修复 bug 等。

提交 Issue 时,请务必使用[Issue 模板](https://github.com/ActivityWatch/activitywatch/issues/new/choose)。这确保我们拥有理解问题所需的信息,避免需要大量的后续问题,从而更快地解决问题!

## 行为准则

我们有一个行为准则,希望所有贡献者遵守,你可以在 [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md) 中找到。

## 提交消息规范

编写提交消息时,请尽量遵循[约定式提交](https://www.conventionalcommits.org/)。这不是硬性要求(为了降低新贡献者的负担),但鼓励遵守。

格式如下:

```
<类型>[可选范围]: <描述>

[可选正文]

[可选页脚]
```

其中 `类型` 可以是以下之一:`feat, fix, chore, ci, docs, style, refactor, perf, test`

示例:

```
- feat: added ability to sort by duration
- fix: fixes incorrect week number (#407)
- docs: improved query documentation
```

此规范在 [issue #391](https://github.com/ActivityWatch/activitywatch/issues/391) 中采纳。

## 获得报酬

我们正在尝试通过捐赠和资助获得的资金向贡献者支付报酬。

基本思路是:你用 ActivityWatch 记录你的工作(并确保正确分类),然后修改 [working_hours.py](https://github.com/ActivityWatch/aw-client/blob/master/examples/working_hours.py) 脚本以使用你的分类规则,生成每日工作时间报告及匹配的事件。

如果你为 ActivityWatch 做出了贡献(至少 10 小时)并希望为你的时间获得报酬,请联系我们!

你可以在[论坛](https://forum.activitywatch.net/t/getting-paid-with-activitywatch/986)和[issues](https://github.com/ActivityWatch/activitywatch/issues/458)中了解更多关于这个实验的信息。

## 领取 GitPOAP

如果你为 ActivityWatch 贡献了提交,你就有资格在以太坊上领取 GitPOAP。你可以在这里了解更多信息:https://twitter.com/ActivityWatchIt/status/1584454595467612160

2022 年的 GitPOAP 如下:

<a href="https://www.gitpoap.io/gh/ActivityWatch/activitywatch">
<img src="https://assets.poap.xyz/gitpoap-2022-activitywatch-contributor-2022-logo-1663695908409.png" width="256px">
</a>

## 问题?

如果你有任何问题,你可以:

- 在[我们的 Discord 服务器][discord]上与我们交流
- 在[论坛][forum]或 [GitHub Discussions][github discussions] 上发帖
- (作为最后手段/如果需要)发送邮件给维护者: [erik@bjareho.lt](mailto:erik@bjareho.lt)

[forum]: https://forum.activitywatch.net
[github discussions]: https://github.com/ActivityWatch/activitywatch/discussions
[discord]: https://discord.gg/vDskV9q
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](/README.md) | [![zh](https://img.shields.io/badge/lang-zh--CN-yellow.svg)](/README.zh.md)

<img title="ActivityWatch" src="https://activitywatch.net/img/banner.png" align="center">

<p align="center">
Expand Down
Loading